{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/datamanager": {
"description": "See, edit, create, import, or delete your customer data in Google Ads, Google Marketing Platform (Campaign Manager 360, Search Ads 360, Display & Video 360), and Google Analytics"
}
}
}
},
"basePath": "",
"baseUrl": "https://datamanager.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Data Manager",
"description": "A unified ingestion API for data partners, agencies and advertisers to connect first-party data across Google advertising products.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/data-manager",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "datamanager:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://datamanager.mtls.googleapis.com/",
"name": "datamanager",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"accountTypes": {
"resources": {
"accounts": {
"resources": {
"insights": {
"methods": {
"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}`",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/insights:retrieve",
"httpMethod": "POST",
"id": "datamanager.accountTypes.accounts.insights.retrieve",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent account that owns the user list. Format: `accountTypes/{account_type}/accounts/{account}`",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/insights:retrieve",
"request": {
"$ref": "RetrieveInsightsRequest"
},
"response": {
"$ref": "RetrieveInsightsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
}
}
},
"partnerLinks": {
"methods": {
"create": {
"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}`",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks",
"httpMethod": "POST",
"id": "datamanager.accountTypes.accounts.partnerLinks.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent, which owns this collection of partner links. Format: accountTypes/{account_type}/accounts/{account}",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/partnerLinks",
"request": {
"$ref": "PartnerLink"
},
"response": {
"$ref": "PartnerLink"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"delete": {
"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}`",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks/{partnerLinksId}",
"httpMethod": "DELETE",
"id": "datamanager.accountTypes.accounts.partnerLinks.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the partner link to delete. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+/partnerLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"search": {
"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}`",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks:search",
"httpMethod": "GET",
"id": "datamanager.accountTypes.accounts.partnerLinks.search",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"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\" AND partner_account.account_id = 987654321`",
"location": "query",
"type": "string"
},
"pageSize": {
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"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",
"type": "string"
},
"parent": {
"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}`",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/partnerLinks:search",
"response": {
"$ref": "SearchPartnerLinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
}
}
},
"userListDirectLicenses": {
"methods": {
"create": {
"description": "Creates a user list direct license. This feature is only available to data partners.",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses",
"httpMethod": "POST",
"id": "datamanager.accountTypes.accounts.userListDirectLicenses.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/userListDirectLicenses",
"request": {
"$ref": "UserListDirectLicense"
},
"response": {
"$ref": "UserListDirectLicense"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"get": {
"description": "Retrieves a user list direct license. This feature is only available to data partners.",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses/{userListDirectLicensesId}",
"httpMethod": "GET",
"id": "datamanager.accountTypes.accounts.userListDirectLicenses.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the user list direct license.",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListDirectLicenses/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "UserListDirectLicense"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"list": {
"description": "Lists all user list direct licenses owned by the parent account. This feature is only available to data partners.",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses",
"httpMethod": "GET",
"id": "datamanager.accountTypes.accounts.userListDirectLicenses.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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 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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"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",
"type": "string"
},
"parent": {
"description": "Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/userListDirectLicenses",
"response": {
"$ref": "ListUserListDirectLicensesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"patch": {
"description": "Updates a user list direct license. This feature is only available to data partners.",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses/{userListDirectLicensesId}",
"httpMethod": "PATCH",
"id": "datamanager.accountTypes.accounts.userListDirectLicenses.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the user list direct license.",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListDirectLicenses/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"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",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "UserListDirectLicense"
},
"response": {
"$ref": "UserListDirectLicense"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
}
}
},
"userListGlobalLicenses": {
"methods": {
"create": {
"description": "Creates a user list global license. This feature is only available to data partners.",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses",
"httpMethod": "POST",
"id": "datamanager.accountTypes.accounts.userListGlobalLicenses.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/userListGlobalLicenses",
"request": {
"$ref": "UserListGlobalLicense"
},
"response": {
"$ref": "UserListGlobalLicense"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"get": {
"description": "Retrieves a user list global license. This feature is only available to data partners.",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}",
"httpMethod": "GET",
"id": "datamanager.accountTypes.accounts.userListGlobalLicenses.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the user list global license.",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "UserListGlobalLicense"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"list": {
"description": "Lists all user list global licenses owned by the parent account. This feature is only available to data partners.",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses",
"httpMethod": "GET",
"id": "datamanager.accountTypes.accounts.userListGlobalLicenses.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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",
"location": "query",
"type": "integer"
},
"pageToken": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/userListGlobalLicenses",
"response": {
"$ref": "ListUserListGlobalLicensesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"patch": {
"description": "Updates a user list global license. This feature is only available to data partners.",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}",
"httpMethod": "PATCH",
"id": "datamanager.accountTypes.accounts.userListGlobalLicenses.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the user list global license.",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"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",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "UserListGlobalLicense"
},
"response": {
"$ref": "UserListGlobalLicense"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
}
},
"resources": {
"userListGlobalLicenseCustomerInfos": {
"methods": {
"list": {
"description": "Lists all customer info for a user list global license. This feature is only available to data partners.",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}/userListGlobalLicenseCustomerInfos",
"httpMethod": "GET",
"id": "datamanager.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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",
"location": "query",
"type": "integer"
},
"pageToken": {
"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",
"type": "string"
},
"parent": {
"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/-`)",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/userListGlobalLicenseCustomerInfos",
"response": {
"$ref": "ListUserListGlobalLicenseCustomerInfosResponse"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
}
}
}
}
},
"userLists": {
"methods": {
"create": {
"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}`",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists",
"httpMethod": "POST",
"id": "datamanager.accountTypes.accounts.userLists.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent account where this user list will be created. Format: accountTypes/{account_type}/accounts/{account}",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. If true, the request is validated but not executed.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/userLists",
"request": {
"$ref": "UserList"
},
"response": {
"$ref": "UserList"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"delete": {
"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}`",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}",
"httpMethod": "DELETE",
"id": "datamanager.accountTypes.accounts.userLists.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the user list to delete. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. If true, the request is validated but not executed.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"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}`",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}",
"httpMethod": "GET",
"id": "datamanager.accountTypes.accounts.userLists.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "UserList"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"list": {
"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}`",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists",
"httpMethod": "GET",
"id": "datamanager.accountTypes.accounts.userLists.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"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`",
"location": "query",
"type": "string"
},
"pageSize": {
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/userLists",
"response": {
"$ref": "ListUserListsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"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}`",
"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}",
"httpMethod": "PATCH",
"id": "datamanager.accountTypes.accounts.userLists.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}",
"location": "path",
"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The list of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If true, the request is validated but not executed.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "UserList"
},
"response": {
"$ref": "UserList"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
}
}
}
}
}
}
},
"audienceMembers": {
"methods": {
"ingest": {
"description": "Uploads a list of AudienceMember resources to the provided Destination.",
"flatPath": "v1/audienceMembers:ingest",
"httpMethod": "POST",
"id": "datamanager.audienceMembers.ingest",
"parameterOrder": [],
"parameters": {},
"path": "v1/audienceMembers:ingest",
"request": {
"$ref": "IngestAudienceMembersRequest"
},
"response": {
"$ref": "IngestAudienceMembersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
},
"remove": {
"description": "Removes a list of AudienceMember resources from the provided Destination.",
"flatPath": "v1/audienceMembers:remove",
"httpMethod": "POST",
"id": "datamanager.audienceMembers.remove",
"parameterOrder": [],
"parameters": {},
"path": "v1/audienceMembers:remove",
"request": {
"$ref": "RemoveAudienceMembersRequest"
},
"response": {
"$ref": "RemoveAudienceMembersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
}
}
},
"events": {
"methods": {
"ingest": {
"description": "Uploads a list of Event resources from the provided Destination.",
"flatPath": "v1/events:ingest",
"httpMethod": "POST",
"id": "datamanager.events.ingest",
"parameterOrder": [],
"parameters": {},
"path": "v1/events:ingest",
"request": {
"$ref": "IngestEventsRequest"
},
"response": {
"$ref": "IngestEventsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
}
}
},
"requestStatus": {
"methods": {
"retrieve": {
"description": "Gets the status of a request given request id.",
"flatPath": "v1/requestStatus:retrieve",
"httpMethod": "GET",
"id": "datamanager.requestStatus.retrieve",
"parameterOrder": [],
"parameters": {
"requestId": {
"description": "Required. Required. The request ID of the Data Manager API request.",
"location": "query",
"type": "string"
}
},
"path": "v1/requestStatus:retrieve",
"response": {
"$ref": "RetrieveRequestStatusResponse"
},
"scopes": [
"https://www.googleapis.com/auth/datamanager"
]
}
}
}
},
"revision": "20260225",
"rootUrl": "https://datamanager.googleapis.com/",
"schemas": {
"AdIdentifiers": {
"description": "Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).",
"id": "AdIdentifiers",
"properties": {
"gbraid": {
"description": "Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.",
"type": "string"
},
"gclid": {
"description": "Optional. The Google click ID (gclid) associated with this event.",
"type": "string"
},
"landingPageDeviceInfo": {
"$ref": "DeviceInfo",
"description": "Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser\u2019s site after interacting with the ad."
},
"sessionAttributes": {
"description": "Optional. Session attributes for event attribution and modeling.",
"type": "string"
},
"wbraid": {
"description": "Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14.",
"type": "string"
}
},
"type": "object"
},
"AddressInfo": {
"description": "Address information for the user.",
"id": "AddressInfo",
"properties": {
"familyName": {
"description": "Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.",
"type": "string"
},
"givenName": {
"description": "Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.",
"type": "string"
},
"postalCode": {
"description": "Required. The postal code of the user's address.",
"type": "string"
},
"regionCode": {
"description": "Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.",
"type": "string"
}
},
"type": "object"
},
"AudienceMember": {
"description": "The audience member to be operated on.",
"id": "AudienceMember",
"properties": {
"consent": {
"$ref": "Consent",
"description": "Optional. The consent setting for the user."
},
"destinationReferences": {
"description": "Optional. Defines which Destination to send the audience member to.",
"items": {
"type": "string"
},
"type": "array"
},
"mobileData": {
"$ref": "MobileData",
"description": "Data identifying the user's mobile devices."
},
"pairData": {
"$ref": "PairData",
"description": "[Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). This feature is only available to data partners."
},
"ppidData": {
"$ref": "PpidData",
"description": "Data related to publisher provided identifiers. This feature is only available to data partners."
},
"userData": {
"$ref": "UserData",
"description": "User-provided data that identifies the user."
},
"userIdData": {
"$ref": "UserIdData",
"description": "Data related to unique identifiers for a user, as defined by the advertiser."
}
},
"type": "object"
},
"AwsWrappedKeyInfo": {
"description": "A data encryption key wrapped by an AWS KMS key.",
"id": "AwsWrappedKeyInfo",
"properties": {
"encryptedDek": {
"description": "Required. The base64 encoded encrypted data encryption key.",
"type": "string"
},
"kekUri": {
"description": "Required. The URI of the AWS KMS key used to decrypt the DEK. Should be in the format of `arn:{partition}:kms:{region}:{account_id}:key/{key_id}` or `aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}`",
"type": "string"
},
"keyType": {
"description": "Required. The type of algorithm used to encrypt the data.",
"enum": [
"KEY_TYPE_UNSPECIFIED",
"XCHACHA20_POLY1305"
],
"enumDescriptions": [
"Unspecified key type. Should never be used.",
"Algorithm XChaCha20-Poly1305"
],
"type": "string"
},
"roleArn": {
"description": "Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of `arn:{partition}:iam::{account_id}:role/{role_name}`",
"type": "string"
}
},
"type": "object"
},
"Baseline": {
"description": "Baseline criteria against which insights are compared.",
"id": "Baseline",
"properties": {
"baselineLocation": {
"$ref": "Location",
"description": "The baseline location of the request. Baseline location is an OR-list of the requested regions."
},
"locationAutoDetectionEnabled": {
"description": "If set to true, the service will try to automatically detect the baseline location for insights.",
"type": "boolean"
}
},
"type": "object"
},
"CartData": {
"description": "The cart data associated with the event.",
"id": "CartData",
"properties": {
"items": {
"description": "Optional. The list of items associated with the event.",
"items": {
"$ref": "Item"
},
"type": "array"
},
"merchantFeedLabel": {
"description": "Optional. The Merchant Center feed label associated with the feed of the items.",
"type": "string"
},
"merchantFeedLanguageCode": {
"description": "Optional. The language code in ISO 639-1 associated with the Merchant Center feed of the items.where your items are uploaded.",
"type": "string"
},
"merchantId": {
"description": "Optional. The Merchant Center ID associated with the items.",
"type": "string"
},
"transactionDiscount": {
"description": "Optional. The sum of all discounts associated with the transaction.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"Consent": {
"description": "[Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user.",
"id": "Consent",
"properties": {
"adPersonalization": {
"description": "Optional. Represents if the user consents to ad personalization.",
"enum": [
"CONSENT_STATUS_UNSPECIFIED",
"CONSENT_GRANTED",
"CONSENT_DENIED"
],
"enumDescriptions": [
"Not specified.",
"Granted.",
"Denied."
],
"type": "string"
},
"adUserData": {
"description": "Optional. Represents if the user consents to ad user data.",
"enum": [
"CONSENT_STATUS_UNSPECIFIED",
"CONSENT_GRANTED",
"CONSENT_DENIED"
],
"enumDescriptions": [
"Not specified.",
"Granted.",
"Denied."
],
"type": "string"
}
},
"type": "object"
},
"ContactIdInfo": {
"description": "Additional information when `CONTACT_ID` is one of the `upload_key_types`.",
"id": "ContactIdInfo",
"properties": {
"dataSourceType": {
"description": "Optional. Immutable. Source of the upload data",
"enum": [
"DATA_SOURCE_TYPE_UNSPECIFIED",
"DATA_SOURCE_TYPE_FIRST_PARTY",
"DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU",
"DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE",
"DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA"
],
"enumDescriptions": [
"Not specified.",
"The uploaded data is first-party data.",
"The uploaded data is from a third-party credit bureau.",
"The uploaded data is from a third-party voter file.",
"The uploaded data is third party partner data."
],
"type": "string"
},
"matchRatePercentage": {
"description": "Output only. Match rate for customer match user lists.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"CustomVariable": {
"description": "Custom variable for ads conversions.",
"id": "CustomVariable",
"properties": {
"destinationReferences": {
"description": "Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.",
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"description": "Optional. The value to store for the custom variable.",
"type": "string"
},
"variable": {
"description": "Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.",
"type": "string"
}
},
"type": "object"
},
"Destination": {
"description": "The Google product you're sending data to. For example, a Google Ads account.",
"id": "Destination",
"properties": {
"linkedAccount": {
"$ref": "ProductAccount",
"description": "Optional. An account that the calling user's `login_account` has access to, through an established account link. For example, a data partner's `login_account` might have access to a client's `linked_account`. The partner might use this field to send data from the `linked_account` to another `operating_account`."
},
"loginAccount": {
"$ref": "ProductAccount",
"description": "Optional. The account used to make this API call. To add or remove data from the `operating_account`, this `login_account` must have write access to the `operating_account`. For example, a manager account of the `operating_account`, or an account with an established link to the `operating_account`."
},
"operatingAccount": {
"$ref": "ProductAccount",
"description": "Required. The account to send the data to or remove the data from."
},
"productDestinationId": {
"description": "Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID.",
"type": "string"
},
"reference": {
"description": "Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.",
"type": "string"
}
},
"type": "object"
},
"DeviceInfo": {
"description": "Information about the device being used (if any) when the event happened.",
"id": "DeviceInfo",
"properties": {
"ipAddress": {
"description": "Optional. The IP address of the device for the given context. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details.",
"type": "string"
},
"userAgent": {
"description": "Optional. The user-agent string of the device for the given context.",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"EncryptionInfo": {
"description": "Encryption information for the data being ingested.",
"id": "EncryptionInfo",
"properties": {
"awsWrappedKeyInfo": {
"$ref": "AwsWrappedKeyInfo",
"description": "Amazon Web Services wrapped key information."
},
"gcpWrappedKeyInfo": {
"$ref": "GcpWrappedKeyInfo",
"description": "Google Cloud Platform wrapped key information."
}
},
"type": "object"
},
"ErrorCount": {
"description": "The error count for a given error reason.",
"id": "ErrorCount",
"properties": {
"reason": {
"description": "The error reason of the failed records.",
"enum": [
"PROCESSING_ERROR_REASON_UNSPECIFIED",
"PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE",
"PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED",
"PROCESSING_ERROR_REASON_EVENT_TOO_OLD",
"PROCESSING_ERROR_REASON_DENIED_CONSENT",
"PROCESSING_ERROR_REASON_NO_CONSENT",
"PROCESSING_ERROR_REASON_UNKNOWN_CONSENT",
"PROCESSING_ERROR_REASON_DUPLICATE_GCLID",
"PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID",
"PROCESSING_ERROR_REASON_INVALID_GBRAID",
"PROCESSING_ERROR_REASON_INVALID_GCLID",
"PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID",
"PROCESSING_ERROR_REASON_INVALID_WBRAID",
"PROCESSING_ERROR_REASON_INTERNAL_ERROR",
"PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED",
"PROCESSING_ERROR_REASON_INVALID_EVENT",
"PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS",
"PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS",
"PROCESSING_ERROR_REASON_INVALID_FORMAT",
"PROCESSING_ERROR_REASON_DECRYPTION_ERROR",
"PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR",
"PROCESSING_ERROR_REASON_INVALID_WIP",
"PROCESSING_ERROR_REASON_INVALID_KEK",
"PROCESSING_ERROR_REASON_WIP_AUTH_FAILED",
"PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED",
"PROCESSING_ERROR_REASON_AWS_AUTH_FAILED",
"PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR",
"PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER"
],
"enumDescriptions": [
"The processing error reason is unknown.",
"The custom variable is invalid.",
"The status of the custom variable is not enabled.",
"The conversion is older than max supported age.",
"The ad user data is denied, either by the user or in the advertiser default settings.",
"Advertiser did not give 3P consent for the Ads core platform services.",
"The overall consent (determined from row level consent, request level consent, and account settings) could not be determined for this user",
"A conversion with the same GCLID and conversion time already exists in the system.",
"A conversion with the same order id and conversion action combination was already uploaded.",
"The gbraid could not be decoded.",
"The google click ID could not be decoded.",
"Merchant id contains non-digit characters.",
"The wbraid could not be decoded.",
"Internal error.",
"Enhanced conversions terms are not signed in the destination account.",
"The event is invalid.",
"The matched transactions are less than the minimum threshold.",
"The transactions are less than the minimum threshold.",
"The event has format error.",
"The event has a decryption error.",
"The DEK failed to be decrypted.",
"The WIP is formatted incorrectly or the WIP does not exist.",
"The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.",
"The WIP could not be used because it was rejected by its attestation condition.",
"The system did not have the permissions needed to access the KEK.",
"The system failed to authenticate with AWS.",
"Failed to decrypt the UserIdentifier data using the DEK.",
"The user attempted to ingest events with an ad identifier that isn't from the operating account's ads."
],
"type": "string"
},
"recordCount": {
"description": "The count of records that failed to upload for a given reason.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ErrorInfo": {
"description": "Error counts for each type of error.",
"id": "ErrorInfo",
"properties": {
"errorCounts": {
"description": "A list of errors and counts per error reason. May not be populated in all cases.",
"items": {
"$ref": "ErrorCount"
},
"type": "array"
}
},
"type": "object"
},
"Event": {
"description": "An event representing a user interaction with an advertiser's website or app.",
"id": "Event",
"properties": {
"adIdentifiers": {
"$ref": "AdIdentifiers",
"description": "Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks)."
},
"additionalEventParameters": {
"description": "Optional. A bucket of any [event parameters](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.",
"items": {
"$ref": "EventParameter"
},
"type": "array"
},
"cartData": {
"$ref": "CartData",
"description": "Optional. Information about the transaction and items associated with the event."
},
"clientId": {
"description": "Optional. A unique identifier for the user instance of a web client for this GA4 web stream.",
"type": "string"
},
"consent": {
"$ref": "Consent",
"description": "Optional. Information about whether the associated user has provided different types of consent."
},
"conversionValue": {
"description": "Optional. The conversion value associated with the event, for value-based conversions.",
"format": "double",
"type": "number"
},
"currency": {
"description": "Optional. The currency code associated with all monetary values within this event.",
"type": "string"
},
"customVariables": {
"description": "Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).",
"items": {
"$ref": "CustomVariable"
},
"type": "array"
},
"destinationReferences": {
"description": "Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.",
"items": {
"type": "string"
},
"type": "array"
},
"eventDeviceInfo": {
"$ref": "DeviceInfo",
"description": "Optional. Information gathered about the device being used (if any) when the event happened."
},
"eventName": {
"description": "Optional. The name of the event. Required for GA4 events.",
"type": "string"
},
"eventSource": {
"description": "Optional. Signal for where the event happened (web, app, in-store, etc.).",
"enum": [
"EVENT_SOURCE_UNSPECIFIED",
"WEB",
"APP",
"IN_STORE",
"PHONE",
"OTHER"
],
"enumDescriptions": [
"Unspecified EventSource. Should never be used.",
"The event was generated from a web browser.",
"The event was generated from an app.",
"The event was generated from an in-store transaction.",
"The event was generated from a phone call.",
"The event was generated from other sources."
],
"type": "string"
},
"eventTimestamp": {
"description": "Required. The time the event occurred.",
"format": "google-datetime",
"type": "string"
},
"experimentalFields": {
"description": "Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.",
"items": {
"$ref": "ExperimentalField"
},
"type": "array"
},
"lastUpdatedTimestamp": {
"description": "Optional. The last time the event was updated.",
"format": "google-datetime",
"type": "string"
},
"transactionId": {
"description": "Optional. The unique identifier for this event. Required for conversions using multiple data sources.",
"type": "string"
},
"userData": {
"$ref": "UserData",
"description": "Optional. Pieces of user provided data, representing the user the event is associated with."
},
"userId": {
"description": "Optional. A unique identifier for a user, as defined by the advertiser.",
"type": "string"
},
"userProperties": {
"$ref": "UserProperties",
"description": "Optional. Advertiser-assessed information about the user at the time that the event happened."
}
},
"type": "object"
},
"EventParameter": {
"description": "Event parameter for GA4 events.",
"id": "EventParameter",
"properties": {
"parameterName": {
"description": "Required. The name of the parameter to use.",
"type": "string"
},
"value": {
"description": "Required. The string representation of the value of the parameter to set.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalField": {
"description": "Experimental field representing unofficial fields.",
"id": "ExperimentalField",
"properties": {
"field": {
"description": "Optional. The name of the field to use.",
"type": "string"
},
"value": {
"description": "Optional. The value the field to set.",
"type": "string"
}
},
"type": "object"
},
"GcpWrappedKeyInfo": {
"description": "Information about the Google Cloud Platform wrapped key.",
"id": "GcpWrappedKeyInfo",
"properties": {
"encryptedDek": {
"description": "Required. The base64 encoded encrypted data encryption key.",
"type": "string"
},
"kekUri": {
"description": "Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}` or `gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}`",
"type": "string"
},
"keyType": {
"description": "Required. The type of algorithm used to encrypt the data.",
"enum": [
"KEY_TYPE_UNSPECIFIED",
"XCHACHA20_POLY1305"
],
"enumDescriptions": [
"Unspecified key type. Should never be used.",
"Algorithm XChaCha20-Poly1305"
],
"type": "string"
},
"wipProvider": {
"description": "Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK.",
"type": "string"
}
},
"type": "object"
},
"IngestAudienceMembersRequest": {
"description": "Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse.",
"id": "IngestAudienceMembersRequest",
"properties": {
"audienceMembers": {
"description": "Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.",
"items": {
"$ref": "AudienceMember"
},
"type": "array"
},
"consent": {
"$ref": "Consent",
"description": "Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each AudienceMember."
},
"destinations": {
"description": "Required. The list of destinations to send the audience members to.",
"items": {
"$ref": "Destination"
},
"type": "array"
},
"encoding": {
"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.",
"enum": [
"ENCODING_UNSPECIFIED",
"HEX",
"BASE64"
],
"enumDescriptions": [
"Unspecified Encoding type. Should never be used.",
"Hex encoding.",
"Base 64 encoding."
],
"type": "string"
},
"encryptionInfo": {
"$ref": "EncryptionInfo",
"description": "Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored."
},
"termsOfService": {
"$ref": "TermsOfService",
"description": "Optional. The terms of service that the user has accepted/rejected."
},
"validateOnly": {
"description": "Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.",
"type": "boolean"
}
},
"type": "object"
},
"IngestAudienceMembersResponse": {
"description": "Response from the IngestAudienceMembersRequest.",
"id": "IngestAudienceMembersResponse",
"properties": {
"requestId": {
"description": "The auto-generated ID of the request.",
"type": "string"
}
},
"type": "object"
},
"IngestAudienceMembersStatus": {
"description": "The status of the ingest audience members request.",
"id": "IngestAudienceMembersStatus",
"properties": {
"mobileDataIngestionStatus": {
"$ref": "IngestMobileDataStatus",
"description": "The status of the mobile data ingestion to the destination."
},
"pairDataIngestionStatus": {
"$ref": "IngestPairDataStatus",
"description": "The status of the pair data ingestion to the destination."
},
"ppidDataIngestionStatus": {
"$ref": "IngestPpidDataStatus",
"description": "The status of the ppid data ingestion to the destination."
},
"userDataIngestionStatus": {
"$ref": "IngestUserDataStatus",
"description": "The status of the user data ingestion to the destination."
},
"userIdDataIngestionStatus": {
"$ref": "IngestUserIdDataStatus",
"description": "The status of the user id data ingestion to the destination."
}
},
"type": "object"
},
"IngestEventsRequest": {
"description": "Request to upload audience members to the provided destinations. Returns an IngestEventsResponse.",
"id": "IngestEventsRequest",
"properties": {
"consent": {
"$ref": "Consent",
"description": "Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each Event."
},
"destinations": {
"description": "Required. The list of destinations to send the events to.",
"items": {
"$ref": "Destination"
},
"type": "array"
},
"encoding": {
"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.",
"enum": [
"ENCODING_UNSPECIFIED",
"HEX",
"BASE64"
],
"enumDescriptions": [
"Unspecified Encoding type. Should never be used.",
"Hex encoding.",
"Base 64 encoding."
],
"type": "string"
},
"encryptionInfo": {
"$ref": "EncryptionInfo",
"description": "Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored."
},
"events": {
"description": "Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.",
"items": {
"$ref": "Event"
},
"type": "array"
},
"validateOnly": {
"description": "Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.",
"type": "boolean"
}
},
"type": "object"
},
"IngestEventsResponse": {
"description": "Response from the IngestEventsRequest.",
"id": "IngestEventsResponse",
"properties": {
"requestId": {
"description": "The auto-generated ID of the request.",
"type": "string"
}
},
"type": "object"
},
"IngestEventsStatus": {
"description": "The status of the events ingestion to the destination.",
"id": "IngestEventsStatus",
"properties": {
"recordCount": {
"description": "The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"IngestMobileDataStatus": {
"description": "The status of the mobile data ingestion to the destination containing stats related to the ingestion.",
"id": "IngestMobileDataStatus",
"properties": {
"mobileIdCount": {
"description": "The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not.",
"format": "int64",
"type": "string"
},
"recordCount": {
"description": "The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"IngestPairDataStatus": {
"description": "The status of the pair data ingestion to the destination containing stats related to the ingestion.",
"id": "IngestPairDataStatus",
"properties": {
"pairIdCount": {
"description": "The total count of pair ids sent in the upload request for the destination. Includes all pair ids in the request, regardless of whether they were successfully ingested or not.",
"format": "int64",
"type": "string"
},
"recordCount": {
"description": "The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"IngestPpidDataStatus": {
"description": "The status of the ppid data ingestion to the destination containing stats related to the ingestion.",
"id": "IngestPpidDataStatus",
"properties": {
"ppidCount": {
"description": "The total count of ppids sent in the upload request for the destination. Includes all ppids in the request, regardless of whether they were successfully ingested or not.",
"format": "int64",
"type": "string"
},
"recordCount": {
"description": "The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"IngestUserDataStatus": {
"description": "The status of the user data ingestion to the destination containing stats related to the ingestion.",
"id": "IngestUserDataStatus",
"properties": {
"recordCount": {
"description": "The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.",
"format": "int64",
"type": "string"
},
"uploadMatchRateRange": {
"description": "The match rate range of the upload.",
"enum": [
"MATCH_RATE_RANGE_UNKNOWN",
"MATCH_RATE_RANGE_NOT_ELIGIBLE",
"MATCH_RATE_RANGE_LESS_THAN_20",
"MATCH_RATE_RANGE_20_TO_30",
"MATCH_RATE_RANGE_31_TO_40",
"MATCH_RATE_RANGE_41_TO_50",
"MATCH_RATE_RANGE_51_TO_60",
"MATCH_RATE_RANGE_61_TO_70",
"MATCH_RATE_RANGE_71_TO_80",
"MATCH_RATE_RANGE_81_TO_90",
"MATCH_RATE_RANGE_91_TO_100"
],
"enumDescriptions": [
"The match rate range is unknown.",
"The match rate range is not eligible.",
"The match rate range is less than 20% (in the interval `[0, 20)`).",
"The match rate range is between 20% and 30% (in the interval `[20, 31)`).",
"The match rate range is between 31% and 40% (in the interval `[31, 41)`).",
"The match rate range is between 41% and 50% (in the interval `[41, 51)`).",
"The match rate range is between 51% and 60% (in the interval `[51, 61)`.",
"The match rate range is between 61% and 70% (in the interval `[61, 71)`).",
"The match rate range is between 71% and 80% (in the interval `[71, 81)`).",
"The match rate range is between 81% and 90% (in the interval `[81, 91)`).",
"The match rate range is between 91% and 100% (in the interval `[91, 100]`)."
],
"type": "string"
},
"userIdentifierCount": {
"description": "The total count of user identifiers sent in the upload request for the destination. Includes all user identifiers in the request, regardless of whether they were successfully ingested or not.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"IngestUserIdDataStatus": {
"description": "The status of the user id data ingestion to the destination containing stats related to the ingestion.",
"id": "IngestUserIdDataStatus",
"properties": {
"recordCount": {
"description": "The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.",
"format": "int64",
"type": "string"
},
"userIdCount": {
"description": "The total count of user ids sent in the upload request for the destination. Includes all user ids in the request, regardless of whether they were successfully ingested or not.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"IngestedUserListInfo": {
"description": "Represents a user list that is populated by user provided data.",
"id": "IngestedUserListInfo",
"properties": {
"contactIdInfo": {
"$ref": "ContactIdInfo",
"description": "Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`."
},
"mobileIdInfo": {
"$ref": "MobileIdInfo",
"description": "Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`."
},
"pairIdInfo": {
"$ref": "PairIdInfo",
"description": "Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners."
},
"partnerAudienceInfo": {
"$ref": "PartnerAudienceInfo",
"description": "Optional. Additional information for partner audiences. This feature is only available to data partners."
},
"pseudonymousIdInfo": {
"$ref": "PseudonymousIdInfo",
"description": "Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`."
},
"uploadKeyTypes": {
"description": "Required. Immutable. Upload key types of this user list.",
"items": {
"enum": [
"UPLOAD_KEY_TYPE_UNSPECIFIED",
"CONTACT_ID",
"MOBILE_ID",
"USER_ID",
"PAIR_ID",
"PSEUDONYMOUS_ID"
],
"enumDescriptions": [
"Not specified.",
"Customer info such as email address, phone number or physical address.",
"Mobile advertising ids.",
"Third party provided user ids.",
"Publisher advertiser identity reconciliation ids.",
"Data Management Platform IDs: - Google User ID - Partner Provided ID - Publisher Provided ID - iOS IDFA - Android advertising ID - Roku ID - Amazon Fire TV ID - Xbox or Microsoft ID"
],
"type": "string"
},
"type": "array"
},
"userIdInfo": {
"$ref": "UserIdInfo",
"description": "Optional. Additional information when `USER_ID` is one of the `upload_key_types`."
}
},
"type": "object"
},
"Item": {
"description": "Represents an item in the cart associated with the event.",
"id": "Item",
"properties": {
"additionalItemParameters": {
"description": "Optional. A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.",
"items": {
"$ref": "ItemParameter"
},
"type": "array"
},
"itemId": {
"description": "Optional. A unique identifier to reference the item.",
"type": "string"
},
"merchantProductId": {
"description": "Optional. The product ID within the Merchant Center account.",
"type": "string"
},
"quantity": {
"description": "Optional. The number of this item associated with the event.",
"format": "int64",
"type": "string"
},
"unitPrice": {
"description": "Optional. The unit price excluding tax, shipping, and any transaction level discounts.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"ItemParameter": {
"description": "A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.",
"id": "ItemParameter",
"properties": {
"parameterName": {
"description": "Required. The name of the parameter to use.",
"type": "string"
},
"value": {
"description": "Required. The string representation of the value of the parameter to set.",
"type": "string"
}
},
"type": "object"
},
"ListUserListDirectLicensesResponse": {
"description": "Response from the ListUserListDirectLicensesRequest.",
"id": "ListUserListDirectLicensesResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"userListDirectLicenses": {
"description": "The licenses for the given user list in the request.",
"items": {
"$ref": "UserListDirectLicense"
},
"type": "array"
}
},
"type": "object"
},
"ListUserListGlobalLicenseCustomerInfosResponse": {
"description": "Response from the ListUserListGlobalLicensesCustomerInfoRequest.",
"id": "ListUserListGlobalLicenseCustomerInfosResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"userListGlobalLicenseCustomerInfos": {
"description": "The customer information for the given license in the request.",
"items": {
"$ref": "UserListGlobalLicenseCustomerInfo"
},
"type": "array"
}
},
"type": "object"
},
"ListUserListGlobalLicensesResponse": {
"description": "Response from the ListUserListGlobalLicensesRequest.",
"id": "ListUserListGlobalLicensesResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"userListGlobalLicenses": {
"description": "The licenses for the given user list in the request.",
"items": {
"$ref": "UserListGlobalLicense"
},
"type": "array"
}
},
"type": "object"
},
"ListUserListsResponse": {
"description": "Response message for ListUserLists.",
"id": "ListUserListsResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"userLists": {
"description": "The user lists from the specified account.",
"items": {
"$ref": "UserList"
},
"type": "array"
}
},
"type": "object"
},
"Location": {
"description": "The baseline location of the request. Baseline location is on OR-list of ISO 3166-1 alpha-2 region codes of the requested regions.",
"id": "Location",
"properties": {
"regionCodes": {
"description": "List of ISO 3166-1 alpha-2 region codes.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MarketingDataInsight": {
"description": "Insights for marketing data. This feature is only available to data partners.",
"id": "MarketingDataInsight",
"properties": {
"attributes": {
"description": "Insights for values of a given dimension.",
"items": {
"$ref": "MarketingDataInsightsAttribute"
},
"type": "array"
},
"dimension": {
"description": "The dimension to which the insight belongs.",
"enum": [
"AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED",
"AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN",
"AFFINITY_USER_INTEREST",
"IN_MARKET_USER_INTEREST",
"AGE_RANGE",
"GENDER"
],
"enumDescriptions": [
"Not specified.",
"The value is unknown in this version.",
"An Affinity UserInterest.",
"An In-Market UserInterest.",
"An age range.",
"A gender."
],
"type": "string"
}
},
"type": "object"
},
"MarketingDataInsightsAttribute": {
"description": "Insights for a collection of related attributes of the same dimension.",
"id": "MarketingDataInsightsAttribute",
"properties": {
"ageRange": {
"description": "Age range of the audience for which the lift is provided.",
"enum": [
"AGE_RANGE_UNSPECIFIED",
"AGE_RANGE_UNKNOWN",
"AGE_RANGE_18_24",
"AGE_RANGE_25_34",
"AGE_RANGE_35_44",
"AGE_RANGE_45_54",
"AGE_RANGE_55_64",
"AGE_RANGE_65_UP"
],
"enumDescriptions": [
"Not specified.",
"Unknown.",
"Between 18 and 24 years old.",
"Between 25 and 34 years old.",
"Between 35 and 44 years old.",
"Between 45 and 54 years old.",
"Between 55 and 64 years old.",
"65 years old and beyond."
],
"type": "string"
},
"gender": {
"description": "Gender of the audience for which the lift is provided.",
"enum": [
"GENDER_UNSPECIFIED",
"GENDER_UNKNOWN",
"GENDER_MALE",
"GENDER_FEMALE"
],
"enumDescriptions": [
"Not specified.",
"Unknown.",
"Male.",
"Female."
],
"type": "string"
},
"lift": {
"description": "Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1].",
"format": "float",
"type": "number"
},
"userInterestId": {
"description": "The user interest ID.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"MobileData": {
"description": "Mobile IDs for the audience. At least one mobile ID is required.",
"id": "MobileData",
"properties": {
"mobileIds": {
"description": "Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `mobileIds` can be provided in a single AudienceMember.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MobileIdInfo": {
"description": "Additional information when `MOBILE_ID` is one of the `upload_key_types`.",
"id": "MobileIdInfo",
"properties": {
"appId": {
"description": "Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.",
"type": "string"
},
"dataSourceType": {
"description": "Optional. Immutable. Source of the upload data.",
"enum": [
"DATA_SOURCE_TYPE_UNSPECIFIED",
"DATA_SOURCE_TYPE_FIRST_PARTY",
"DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU",
"DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE",
"DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA"
],
"enumDescriptions": [
"Not specified.",
"The uploaded data is first-party data.",
"The uploaded data is from a third-party credit bureau.",
"The uploaded data is from a third-party voter file.",
"The uploaded data is third party partner data."
],
"type": "string"
},
"keySpace": {
"description": "Required. Immutable. The key space of mobile IDs.",
"enum": [
"KEY_SPACE_UNSPECIFIED",
"IOS",
"ANDROID"
],
"enumDescriptions": [
"Not specified.",
"The iOS keyspace.",
"The Android keyspace."
],
"type": "string"
}
},
"type": "object"
},
"PairData": {
"description": "[PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience. At least one PAIR ID is required. This feature is only available to data partners.",
"id": "PairData",
"properties": {
"pairIds": {
"description": "Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the [PAIR]((//support.google.com/admanager/answer/15067908)) user list. At most 10 `pairIds` can be provided in a single AudienceMember.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PairIdInfo": {
"description": "Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.",
"id": "PairIdInfo",
"properties": {
"advertiserIdentifierCount": {
"description": "Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.",
"format": "int64",
"type": "string"
},
"cleanRoomIdentifier": {
"description": "Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.",
"type": "string"
},
"matchRatePercentage": {
"description": "Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.",
"format": "int32",
"type": "integer"
},
"publisherId": {
"description": "Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.",
"format": "int64",
"type": "string"
},
"publisherName": {
"description": "Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.",
"type": "string"
}
},
"type": "object"
},
"PartnerAudienceInfo": {
"description": "Additional information for partner audiences. This feature is only available to data partners.",
"id": "PartnerAudienceInfo",
"properties": {
"commercePartner": {
"description": "Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.",
"type": "string"
},
"partnerAudienceSource": {
"description": "Required. Immutable. The source of the partner audience.",
"enum": [
"PARTNER_AUDIENCE_SOURCE_UNSPECIFIED",
"COMMERCE_AUDIENCE",
"LINEAR_TV_AUDIENCE",
"AGENCY_PROVIDER_AUDIENCE"
],
"enumDescriptions": [
"Not specified.",
"Partner Audience source is commerce audience.",
"Partner Audience source is linear TV audience.",
"Partner Audience source is agency/provider audience."
],
"type": "string"
}
},
"type": "object"
},
"PartnerLink": {
"description": "A partner link between an owning account and a partner account.",
"id": "PartnerLink",
"properties": {
"name": {
"description": "Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}",
"type": "string"
},
"owningAccount": {
"$ref": "ProductAccount",
"description": "Required. The owning account granting access to the partner account."
},
"partnerAccount": {
"$ref": "ProductAccount",
"description": "Required. The partner account granted access by the owning account."
},
"partnerLinkId": {
"description": "Output only. The partner link ID.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PpidData": {
"description": "Publisher provided identifiers data holding the ppids. At least one ppid is required. This feature is only available to data partners.",
"id": "PpidData",
"properties": {
"ppids": {
"description": "Required. The list of publisher provided identifiers for a user.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ProductAccount": {
"description": "Represents a specific account.",
"id": "ProductAccount",
"properties": {
"accountId": {
"description": "Required. The ID of the account. For example, your Google Ads account ID.",
"type": "string"
},
"accountType": {
"description": "Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.",
"enum": [
"ACCOUNT_TYPE_UNSPECIFIED",
"GOOGLE_ADS",
"DISPLAY_VIDEO_PARTNER",
"DISPLAY_VIDEO_ADVERTISER",
"DATA_PARTNER",
"GOOGLE_ANALYTICS_PROPERTY",
"GOOGLE_AD_MANAGER_AUDIENCE_LINK"
],
"enumDescriptions": [
"Unspecified product. Should never be used.",
"Google Ads.",
"Display & Video 360 partner.",
"Display & Video 360 advertiser.",
"Data Partner.",
"Google Analytics.",
"Google Ad Manager audience link."
],
"type": "string"
},
"product": {
"deprecated": true,
"description": "Deprecated. Use `account_type` instead.",
"enum": [
"PRODUCT_UNSPECIFIED",
"GOOGLE_ADS",
"DISPLAY_VIDEO_PARTNER",
"DISPLAY_VIDEO_ADVERTISER",
"DATA_PARTNER"
],
"enumDescriptions": [
"Unspecified product. Should never be used.",
"Google Ads.",
"Display & Video 360 partner.",
"Display & Video 360 advertiser.",
"Data Partner."
],
"type": "string"
}
},
"type": "object"
},
"PseudonymousIdInfo": {
"description": "Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`.",
"id": "PseudonymousIdInfo",
"properties": {
"billableRecordCount": {
"description": "Optional. Immutable. The number of billable records (e.g. uploaded or matched).",
"format": "int64",
"type": "string"
},
"syncStatus": {
"description": "Output only. Sync status of the user list.",
"enum": [
"SYNC_STATUS_UNSPECIFIED",
"CREATED",
"READY_FOR_USE",
"FAILED"
],
"enumDescriptions": [
"Not specified.",
"The user list has been created as a placeholder. List contents and/or metadata are still being synced. The user list is not ready for use.",
"The user list is ready for use. Contents and cookies have been synced correctly.",
"An error has occurred syncing user list contents and/or metadata. The user list cannot be used."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"RemoveAudienceMembersRequest": {
"description": "Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse.",
"id": "RemoveAudienceMembersRequest",
"properties": {
"audienceMembers": {
"description": "Required. The list of users to remove.",
"items": {
"$ref": "AudienceMember"
},
"type": "array"
},
"destinations": {
"description": "Required. The list of destinations to remove the users from.",
"items": {
"$ref": "Destination"
},
"type": "array"
},
"encoding": {
"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. Applies to only the outer encoding for encrypted user identifiers. For non `UserData` uploads, this field is ignored.",
"enum": [
"ENCODING_UNSPECIFIED",
"HEX",
"BASE64"
],
"enumDescriptions": [
"Unspecified Encoding type. Should never be used.",
"Hex encoding.",
"Base 64 encoding."
],
"type": "string"
},
"encryptionInfo": {
"$ref": "EncryptionInfo",
"description": "Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored."
},
"validateOnly": {
"description": "Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.",
"type": "boolean"
}
},
"type": "object"
},
"RemoveAudienceMembersResponse": {
"description": "Response from the RemoveAudienceMembersRequest.",
"id": "RemoveAudienceMembersResponse",
"properties": {
"requestId": {
"description": "The auto-generated ID of the request.",
"type": "string"
}
},
"type": "object"
},
"RemoveAudienceMembersStatus": {
"description": "The status of the remove audience members request.",
"id": "RemoveAudienceMembersStatus",
"properties": {
"mobileDataRemovalStatus": {
"$ref": "RemoveMobileDataStatus",
"description": "The status of the mobile data removal from the destination."
},
"pairDataRemovalStatus": {
"$ref": "RemovePairDataStatus",
"description": "The status of the pair data removal from the destination."
},
"ppidDataRemovalStatus": {
"$ref": "RemovePpidDataStatus",
"description": "The status of the ppid data removal from the destination."
},
"userDataRemovalStatus": {
"$ref": "RemoveUserDataStatus",
"description": "The status of the user data removal from the destination."
},
"userIdDataRemovalStatus": {
"$ref": "RemoveUserIdDataStatus",
"description": "The status of the user id data removal from the destination."
}
},
"type": "object"
},
"RemoveMobileDataStatus": {
"description": "The status of the mobile data removal from the destination.",
"id": "RemoveMobileDataStatus",
"properties": {
"mobileIdCount": {
"description": "The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not.",
"format": "int64",
"type": "string"
},
"recordCount": {
"description": "The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"RemovePairDataStatus": {
"description": "The status of the pair data removal from the destination.",
"id": "RemovePairDataStatus",
"properties": {
"pairIdCount": {
"description": "The total count of pair ids sent in the removal request. Includes all pair ids in the request, regardless of whether they were successfully removed or not.",
"format": "int64",
"type": "string"
},
"recordCount": {
"description": "The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"RemovePpidDataStatus": {
"description": "The status of the ppid data removal from the destination.",
"id": "RemovePpidDataStatus",
"properties": {
"ppidCount": {
"description": "The total count of ppids sent in the removal request. Includes all ppids in the request, regardless of whether they were successfully removed or not.",
"format": "int64",
"type": "string"
},
"recordCount": {
"description": "The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"RemoveUserDataStatus": {
"description": "The status of the user data removal from the destination.",
"id": "RemoveUserDataStatus",
"properties": {
"recordCount": {
"description": "The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.",
"format": "int64",
"type": "string"
},
"userIdentifierCount": {
"description": "The total count of user identifiers sent in the removal request. Includes all user identifiers in the request, regardless of whether they were successfully removed or not.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"RemoveUserIdDataStatus": {
"description": "The status of the user id data removal from the destination.",
"id": "RemoveUserIdDataStatus",
"properties": {
"recordCount": {
"description": "The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.",
"format": "int64",
"type": "string"
},
"userIdCount": {
"description": "The total count of user ids sent in the removal request. Includes all user ids in the request, regardless of whether they were successfully removed or not.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"RequestStatusPerDestination": {
"description": "A request status per destination.",
"id": "RequestStatusPerDestination",
"properties": {
"audienceMembersIngestionStatus": {
"$ref": "IngestAudienceMembersStatus",
"description": "The status of the ingest audience members request."
},
"audienceMembersRemovalStatus": {
"$ref": "RemoveAudienceMembersStatus",
"description": "The status of the remove audience members request."
},
"destination": {
"$ref": "Destination",
"description": "A destination within a DM API request."
},
"errorInfo": {
"$ref": "ErrorInfo",
"description": "An error info error containing the error reason and error counts related to the upload."
},
"eventsIngestionStatus": {
"$ref": "IngestEventsStatus",
"description": "The status of the ingest events request."
},
"requestStatus": {
"description": "The request status of the destination.",
"enum": [
"REQUEST_STATUS_UNKNOWN",
"SUCCESS",
"PROCESSING",
"FAILED",
"PARTIAL_SUCCESS"
],
"enumDescriptions": [
"The request status is unknown.",
"The request succeeded.",
"The request is processing.",
"The request failed.",
"The request partially succeeded."
],
"type": "string"
},
"warningInfo": {
"$ref": "WarningInfo",
"description": "A warning info containing the warning reason and warning counts related to the upload."
}
},
"type": "object"
},
"RetrieveInsightsRequest": {
"description": "Request message for DM API MarketingDataInsightsService.RetrieveInsights",
"id": "RetrieveInsightsRequest",
"properties": {
"baseline": {
"$ref": "Baseline",
"description": "Required. Baseline for the insights requested."
},
"userListId": {
"description": "Required. The user list ID for which insights are requested.",
"type": "string"
}
},
"type": "object"
},
"RetrieveInsightsResponse": {
"description": "Response message for DM API MarketingDataInsightsService.RetrieveInsights",
"id": "RetrieveInsightsResponse",
"properties": {
"marketingDataInsights": {
"description": "Contains the insights for the marketing data.",
"items": {
"$ref": "MarketingDataInsight"
},
"type": "array"
}
},
"type": "object"
},
"RetrieveRequestStatusResponse": {
"description": "Response from the RetrieveRequestStatusRequest.",
"id": "RetrieveRequestStatusResponse",
"properties": {
"requestStatusPerDestination": {
"description": "A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request.",
"items": {
"$ref": "RequestStatusPerDestination"
},
"type": "array"
}
},
"type": "object"
},
"SearchPartnerLinksResponse": {
"description": "Response from the SearchPartnerLinksRequest.",
"id": "SearchPartnerLinksResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"partnerLinks": {
"description": "The partner links for the given account.",
"items": {
"$ref": "PartnerLink"
},
"type": "array"
}
},
"type": "object"
},
"SizeInfo": {
"description": "Estimated number of members in this user list in different target networks.",
"id": "SizeInfo",
"properties": {
"displayNetworkMembersCount": {
"description": "Output only. Estimated number of members in this user list, on the Google Display Network.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"searchNetworkMembersCount": {
"description": "Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"TargetNetworkInfo": {
"description": "Eligibility information for different target networks.",
"id": "TargetNetworkInfo",
"properties": {
"eligibleForDisplay": {
"description": "Output only. Indicates this user list is eligible for Google Display Network.",
"readOnly": true,
"type": "boolean"
},
"eligibleForSearch": {
"description": "Optional. Indicates if this user list is eligible for Google Search Network.",
"type": "boolean"
}
},
"type": "object"
},
"TermsOfService": {
"description": "The terms of service that the user has accepted/rejected.",
"id": "TermsOfService",
"properties": {
"customerMatchTermsOfServiceStatus": {
"description": "Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717. This must be accepted when ingesting UserData or MobileData. This field is not required for Partner Match User list.",
"enum": [
"TERMS_OF_SERVICE_STATUS_UNSPECIFIED",
"ACCEPTED",
"REJECTED"
],
"enumDescriptions": [
"Not specified.",
"Status indicating the caller has chosen to accept the terms of service.",
"Status indicating the caller has chosen to reject the terms of service."
],
"type": "string"
}
},
"type": "object"
},
"UserData": {
"description": "Data that identifies the user. At least one identifier is required.",
"id": "UserData",
"properties": {
"userIdentifiers": {
"description": "Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event.",
"items": {
"$ref": "UserIdentifier"
},
"type": "array"
}
},
"type": "object"
},
"UserIdData": {
"description": "User id data holding the user id.",
"id": "UserIdData",
"properties": {
"userId": {
"description": "Required. A unique identifier for a user, as defined by the advertiser.",
"type": "string"
}
},
"type": "object"
},
"UserIdInfo": {
"description": "Additional information when `USER_ID` is one of the `upload_key_types`.",
"id": "UserIdInfo",
"properties": {
"dataSourceType": {
"description": "Optional. Immutable. Source of the upload data.",
"enum": [
"DATA_SOURCE_TYPE_UNSPECIFIED",
"DATA_SOURCE_TYPE_FIRST_PARTY",
"DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU",
"DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE",
"DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA"
],
"enumDescriptions": [
"Not specified.",
"The uploaded data is first-party data.",
"The uploaded data is from a third-party credit bureau.",
"The uploaded data is from a third-party voter file.",
"The uploaded data is third party partner data."
],
"type": "string"
}
},
"type": "object"
},
"UserIdentifier": {
"description": "A single identifier for the user.",
"id": "UserIdentifier",
"properties": {
"address": {
"$ref": "AddressInfo",
"description": "The known components of a user's address. Holds a grouping of identifiers that are matched all at once."
},
"emailAddress": {
"description": "Hashed email address using SHA-256 hash function after normalization.",
"type": "string"
},
"phoneNumber": {
"description": "Hashed phone number using SHA-256 hash function after normalization (E164 standard).",
"type": "string"
}
},
"type": "object"
},
"UserList": {
"description": "A user list resource.",
"id": "UserList",
"properties": {
"accessReason": {
"description": "Output only. The reason this account has been granted access to the list.",
"enum": [
"ACCESS_REASON_UNSPECIFIED",
"OWNED",
"SHARED",
"LICENSED",
"SUBSCRIBED",
"AFFILIATED"
],
"enumDescriptions": [
"Not specified.",
"The resource is owned by the user.",
"The resource is shared to the user.",
"The resource is licensed to the user.",
"The user subscribed to the resource.",
"The resource is accessible to the user."
],
"readOnly": true,
"type": "string"
},
"accountAccessStatus": {
"description": "Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`.",
"enum": [
"ACCESS_STATUS_UNSPECIFIED",
"ENABLED",
"DISABLED"
],
"enumDescriptions": [
"Not specified.",
"The access is enabled.",
"The access is disabled."
],
"type": "string"
},
"closingReason": {
"description": "Output only. The reason why this user list membership status is closed.",
"enum": [
"CLOSING_REASON_UNSPECIFIED",
"UNUSED"
],
"enumDescriptions": [
"Not specified.",
"The user list was closed because it has not been used in targeting recently. See https://support.google.com/google-ads/answer/2472738 for details."
],
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. A description of the user list.",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the user list.",
"type": "string"
},
"id": {
"description": "Output only. The unique ID of the user list.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"ingestedUserListInfo": {
"$ref": "IngestedUserListInfo",
"description": "Optional. Represents a user list that is populated by user ingested data."
},
"integrationCode": {
"description": "Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.",
"type": "string"
},
"membershipDuration": {
"description": "Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.",
"format": "google-duration",
"type": "string"
},
"membershipStatus": {
"description": "Optional. Membership status of this user list.",
"enum": [
"MEMBERSHIP_STATUS_UNSPECIFIED",
"OPEN",
"CLOSED"
],
"enumDescriptions": [
"Not specified.",
"Open status - User list is accruing members and can be targeted to.",
"Closed status - No new members being added."
],
"type": "string"
},
"name": {
"description": "Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}",
"type": "string"
},
"readOnly": {
"description": "Output only. An option that indicates if a user may edit a list.",
"readOnly": true,
"type": "boolean"
},
"sizeInfo": {
"$ref": "SizeInfo",
"description": "Output only. Estimated number of members in this user list in different target networks.",
"readOnly": true
},
"targetNetworkInfo": {
"$ref": "TargetNetworkInfo",
"description": "Optional. Eligibility information for different target networks."
}
},
"type": "object"
},
"UserListDirectLicense": {
"description": "A user list direct license. This feature is only available to data partners.",
"id": "UserListDirectLicense",
"properties": {
"clientAccountDisplayName": {
"description": "Output only. Name of client customer which the user list is being licensed to. This field is read-only.",
"readOnly": true,
"type": "string"
},
"clientAccountId": {
"description": "Immutable. ID of client customer which the user list is being licensed to.",
"format": "int64",
"type": "string"
},
"clientAccountType": {
"description": "Immutable. Account type of client customer which the user list is being licensed to.",
"enum": [
"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN",
"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS",
"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER",
"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER",
"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK"
],
"enumDescriptions": [
"Unknown.",
"Google Ads customer.",
"Display & Video 360 partner.",
"Display & Video 360 advertiser.",
"Google Ad Manager audience link."
],
"type": "string"
},
"historicalPricings": {
"description": "Output only. Pricing history of this user list license. This field is read-only.",
"items": {
"$ref": "UserListLicensePricing"
},
"readOnly": true,
"type": "array"
},
"metrics": {
"$ref": "UserListLicenseMetrics",
"description": "Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call",
"readOnly": true
},
"name": {
"description": "Identifier. The resource name of the user list direct license.",
"type": "string"
},
"pricing": {
"$ref": "UserListLicensePricing",
"description": "Optional. UserListDirectLicense pricing."
},
"status": {
"description": "Optional. Status of UserListDirectLicense - ENABLED or DISABLED.",
"enum": [
"USER_LIST_LICENSE_STATUS_UNSPECIFIED",
"USER_LIST_LICENSE_STATUS_ENABLED",
"USER_LIST_LICENSE_STATUS_DISABLED"
],
"enumDescriptions": [
"Unknown.",
"Active status - user list is still being licensed.",
"Inactive status - user list is no longer being licensed."
],
"type": "string"
},
"userListDisplayName": {
"description": "Output only. Name of the user list being licensed. This field is read-only.",
"readOnly": true,
"type": "string"
},
"userListId": {
"description": "Immutable. ID of the user list being licensed.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"UserListGlobalLicense": {
"description": "A user list global license. This feature is only available to data partners.",
"id": "UserListGlobalLicense",
"properties": {
"historicalPricings": {
"description": "Output only. Pricing history of this user list license. This field is read-only.",
"items": {
"$ref": "UserListLicensePricing"
},
"readOnly": true,
"type": "array"
},
"licenseType": {
"description": "Immutable. Product type of client customer which the user list is being licensed to.",
"enum": [
"USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED",
"USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER",
"USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE",
"USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE"
],
"enumDescriptions": [
"UNSPECIFIED.",
"Reseller license.",
"DataMart Sell Side license.",
"DataMart Buy Side license."
],
"type": "string"
},
"metrics": {
"$ref": "UserListLicenseMetrics",
"description": "Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call",
"readOnly": true
},
"name": {
"description": "Identifier. The resource name of the user list global license.",
"type": "string"
},
"pricing": {
"$ref": "UserListLicensePricing",
"description": "Optional. UserListGlobalLicense pricing."
},
"status": {
"description": "Optional. Status of UserListGlobalLicense - ENABLED or DISABLED.",
"enum": [
"USER_LIST_LICENSE_STATUS_UNSPECIFIED",
"USER_LIST_LICENSE_STATUS_ENABLED",
"USER_LIST_LICENSE_STATUS_DISABLED"
],
"enumDescriptions": [
"Unknown.",
"Active status - user list is still being licensed.",
"Inactive status - user list is no longer being licensed."
],
"type": "string"
},
"userListDisplayName": {
"description": "Output only. Name of the user list being licensed. This field is read-only.",
"readOnly": true,
"type": "string"
},
"userListId": {
"description": "Immutable. ID of the user list being licensed.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"UserListGlobalLicenseCustomerInfo": {
"description": "Information about a customer of a user list global license. This will automatically be created by the system when a customer purchases a global license.",
"id": "UserListGlobalLicenseCustomerInfo",
"properties": {
"clientAccountDisplayName": {
"description": "Output only. Name of client customer which the user list is being licensed to.",
"readOnly": true,
"type": "string"
},
"clientAccountId": {
"description": "Output only. ID of client customer which the user list is being licensed to.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"clientAccountType": {
"description": "Output only. Product type of client customer which the user list is being licensed to.",
"enum": [
"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN",
"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS",
"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER",
"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER",
"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK"
],
"enumDescriptions": [
"Unknown.",
"Google Ads customer.",
"Display & Video 360 partner.",
"Display & Video 360 advertiser.",
"Google Ad Manager audience link."
],
"readOnly": true,
"type": "string"
},
"historicalPricings": {
"description": "Output only. Pricing history of this user list license.",
"items": {
"$ref": "UserListLicensePricing"
},
"readOnly": true,
"type": "array"
},
"licenseType": {
"description": "Output only. Product type of client customer which the user list is being licensed to.",
"enum": [
"USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED",
"USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER",
"USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE",
"USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE"
],
"enumDescriptions": [
"UNSPECIFIED.",
"Reseller license.",
"DataMart Sell Side license.",
"DataMart Buy Side license."
],
"readOnly": true,
"type": "string"
},
"metrics": {
"$ref": "UserListLicenseMetrics",
"description": "Output only. Metrics related to this license This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call.",
"readOnly": true
},
"name": {
"description": "Identifier. The resource name of the user list global license customer.",
"type": "string"
},
"pricing": {
"$ref": "UserListLicensePricing",
"description": "Output only. UserListDirectLicense pricing.",
"readOnly": true
},
"status": {
"description": "Output only. Status of UserListDirectLicense - ENABLED or DISABLED.",
"enum": [
"USER_LIST_LICENSE_STATUS_UNSPECIFIED",
"USER_LIST_LICENSE_STATUS_ENABLED",
"USER_LIST_LICENSE_STATUS_DISABLED"
],
"enumDescriptions": [
"Unknown.",
"Active status - user list is still being licensed.",
"Inactive status - user list is no longer being licensed."
],
"readOnly": true,
"type": "string"
},
"userListDisplayName": {
"description": "Output only. Name of the user list being licensed.",
"readOnly": true,
"type": "string"
},
"userListId": {
"description": "Output only. ID of the user list being licensed.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"UserListLicenseMetrics": {
"description": "Metrics related to a user list license.",
"id": "UserListLicenseMetrics",
"properties": {
"clickCount": {
"description": "Output only. The number of clicks for the user list license.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"endDate": {
"description": "Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"impressionCount": {
"description": "Output only. The number of impressions for the user list license.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"revenueUsdMicros": {
"description": "Output only. The revenue for the user list license in USD micros.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"startDate": {
"description": "Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"UserListLicensePricing": {
"description": "A user list license pricing.",
"id": "UserListLicensePricing",
"properties": {
"buyerApprovalState": {
"description": "Output only. The buyer approval state of this pricing. This field is read-only.",
"enum": [
"USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED",
"PENDING",
"APPROVED",
"REJECTED"
],
"enumDescriptions": [
"UNSPECIFIED.",
"User list client has not yet accepted the pricing terms set by the user list owner.",
"User list client has accepted the pricing terms set by the user list owner.",
"User list client has rejected the pricing terms set by the user list owner."
],
"readOnly": true,
"type": "string"
},
"costMicros": {
"description": "Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`.",
"format": "int64",
"type": "string"
},
"costType": {
"description": "Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.",
"enum": [
"USER_LIST_PRICING_COST_TYPE_UNSPECIFIED",
"CPC",
"CPM",
"MEDIA_SHARE"
],
"enumDescriptions": [
"Unspecified.",
"Cost per click.",
"Cost per mille (thousand impressions).",
"Media share."
],
"type": "string"
},
"currencyCode": {
"description": "Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.",
"type": "string"
},
"endTime": {
"description": "Optional. End time of the pricing.",
"format": "google-datetime",
"type": "string"
},
"maxCostMicros": {
"description": "Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap.",
"format": "int64",
"type": "string"
},
"pricingActive": {
"description": "Output only. Whether this pricing is active.",
"readOnly": true,
"type": "boolean"
},
"pricingId": {
"description": "Output only. The ID of this pricing.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. Start time of the pricing.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"UserProperties": {
"description": "Advertiser-assessed information about the user at the time that the event happened. See https://support.google.com/google-ads/answer/14007601 for more details.",
"id": "UserProperties",
"properties": {
"additionalUserProperties": {
"description": "Optional. A bucket of any additional [user properties](https://developers.google.com/analytics/devguides/collection/protocol/ga4/user-properties) for the user associated with this event.",
"items": {
"$ref": "UserProperty"
},
"type": "array"
},
"customerType": {
"description": "Optional. Type of the customer associated with the event.",
"enum": [
"CUSTOMER_TYPE_UNSPECIFIED",
"NEW",
"RETURNING",
"REENGAGED"
],
"enumDescriptions": [
"Unspecified CustomerType. Should never be used.",
"The customer is new to the advertiser.",
"The customer is returning to the advertiser.",
"The customer has re-engaged with the advertiser."
],
"type": "string"
},
"customerValueBucket": {
"description": "Optional. The advertiser-assessed value of the customer.",
"enum": [
"CUSTOMER_VALUE_BUCKET_UNSPECIFIED",
"LOW",
"MEDIUM",
"HIGH"
],
"enumDescriptions": [
"Unspecified CustomerValueBucket. Should never be used.",
"The customer is low value.",
"The customer is medium value.",
"The customer is high value."
],
"type": "string"
}
},
"type": "object"
},
"UserProperty": {
"description": "A bucket of any additional [user properties](https://developers.google.com/analytics/devguides/collection/protocol/ga4/user-properties) for the user associated with this event.",
"id": "UserProperty",
"properties": {
"propertyName": {
"description": "Required. The name of the user property to use.",
"type": "string"
},
"value": {
"description": "Required. The string representation of the value of the user property to use.",
"type": "string"
}
},
"type": "object"
},
"WarningCount": {
"description": "The warning count for a given warning reason.",
"id": "WarningCount",
"properties": {
"reason": {
"description": "The warning reason.",
"enum": [
"PROCESSING_WARNING_REASON_UNSPECIFIED",
"PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED",
"PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR",
"PROCESSING_WARNING_REASON_DECRYPTION_ERROR",
"PROCESSING_WARNING_REASON_WIP_AUTH_FAILED",
"PROCESSING_WARNING_REASON_INVALID_WIP",
"PROCESSING_WARNING_REASON_INVALID_KEK",
"PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR",
"PROCESSING_WARNING_REASON_INTERNAL_ERROR",
"PROCESSING_WARNING_REASON_AWS_AUTH_FAILED"
],
"enumDescriptions": [
"The processing warning reason is unknown.",
"The system did not have the permissions needed to access the KEK.",
"The DEK failed to be decrypted.",
"The event has a decryption error.",
"The WIP could not be used because it was rejected by its attestation condition.",
"The WIP is formatted incorrectly or the WIP does not exist.",
"The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.",
"Failed to decrypt th UserIdentifier data using the DEK.",
"Internal error.",
"The system failed to authenticate with AWS."
],
"type": "string"
},
"recordCount": {
"description": "The count of records that have a warning.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"WarningInfo": {
"description": "Warning counts for each type of warning.",
"id": "WarningInfo",
"properties": {
"warningCounts": {
"description": "A list of warnings and counts per warning reason.",
"items": {
"$ref": "WarningCount"
},
"type": "array"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Data Manager API",
"version": "v1",
"version_module": true
}