Data Manager API (datamanager:v1)

2026-09-10

19 updated methods

Updates

    Methods
  • datamanager.requestStatus.retrieve

      Parameters :

        requestId

          Location : query

          Description : Required. Required. The request ID of the Data Manager API request.

          Type : string

  • datamanager.accountTypes.accounts.userLists.get

      Parameters :

        name

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$

          Location : path

          Description : Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

          Required : Yes

          Type : string

  • datamanager.accountTypes.accounts.userLists.delete

      Parameters :

        validateOnly

          Location : query

          Type : boolean

          Description : Optional. If true, the request is validated but not executed.

        name

          Required : Yes

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$

          Type : string

          Description : Required. The name of the user list to delete. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

          Location : path

  • datamanager.accountTypes.accounts.userLists.patch

      Parameters :

        name

          Required : Yes

          Description : Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

          Type : string

          Location : path

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$

        updateMask

          Format : google-fieldmask

          Type : string

          Description : Optional. The list of fields to update.

          Location : query

        validateOnly

          Description : Optional. If true, the request is validated but not executed.

          Location : query

          Type : boolean

  • datamanager.accountTypes.accounts.userLists.create

      Parameters :

        parent

          Type : string

          Required : Yes

          Location : path

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+$

          Description : Required. The parent account where this user list will be created. Format: accountTypes/{account_type}/accounts/{account}

        validateOnly

          Location : query

          Type : boolean

          Description : Optional. If true, the request is validated but not executed.

  • datamanager.accountTypes.accounts.userLists.list

      Parameters :

        pageSize

          Type : integer

          Description : Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Location : query

          Format : int32

        filter

          Type : string

          Description : Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = "list 1"`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(display_name, "name1", "name2")` Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types`

          Location : query

        parent

          Location : path

          Type : string

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+$

          Required : Yes

          Description : Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}

        pageToken

          Type : string

          Location : query

          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.

  • datamanager.accountTypes.accounts.userListDirectLicenses.create

      Parameters :

        parent

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+$

          Type : string

          Location : path

          Required : Yes

          Description : Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

  • datamanager.accountTypes.accounts.userListDirectLicenses.list

      Parameters :

        filter

          Type : string

          Description : Optional. A [filter string](https://google.aip.dev/160) 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`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`

          Location : query

        pageToken

          Location : query

          Description : Optional. A page token, received from a previous `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.

          Type : string

        parent

          Description : Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

          Type : string

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+$

          Location : path

          Required : Yes

        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.

          Type : integer

          Format : int32

          Location : query

  • datamanager.accountTypes.accounts.userListDirectLicenses.get

      Parameters :

        name

          Required : Yes

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userListDirectLicenses/[^/]+$

          Type : string

          Description : Required. The resource name of the user list direct license.

          Location : path

  • datamanager.accountTypes.accounts.userListDirectLicenses.patch

      Parameters :

        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

        name

          Location : path

          Required : Yes

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userListDirectLicenses/[^/]+$

          Type : string

          Description : Identifier. The resource name of the user list direct license.

  • datamanager.accountTypes.accounts.partnerLinks.search

      Parameters :

        filter

          Description : Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` - `feature_set` For partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set, the following fields are also supported: - `partner_customer_account.account_id` - `partner_link_metadata.implicit_accounts.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321`

          Type : string

          Location : query

        pageToken

          Location : query

          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.

          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}`

          Required : Yes

          Location : path

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+$

          Type : string

        pageSize

          Location : query

          Description : The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 50 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.

          Format : int32

          Type : integer

  • datamanager.accountTypes.accounts.partnerLinks.create

      Parameters :

        parent

          Required : Yes

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+$

          Description : Required. The parent, which owns this collection of partner links. Format: accountTypes/{account_type}/accounts/{account}

          Type : string

          Location : path

  • datamanager.accountTypes.accounts.partnerLinks.delete

      Parameters :

        name

          Description : Required. The resource name of the partner link to delete. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

          Type : string

          Location : path

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+/partnerLinks/[^/]+$

          Required : Yes

  • datamanager.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.list

      Parameters :

        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 : Yes

          Type : string

        pageSize

          Location : query

          Description : Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Format : int32

          Type : integer

        pageToken

          Location : query

          Type : string

          Description : Optional. A page token, received from a previous `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.

        filter

          Description : Optional. A [filter string](https://google.aip.dev/160) 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`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`

          Location : query

          Type : string

  • datamanager.accountTypes.accounts.userListGlobalLicenses.list

      Parameters :

        parent

          Required : Yes

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+$

          Type : string

          Description : Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

          Location : path

        pageSize

          Format : int32

          Type : integer

          Location : query

          Description : Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

        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

        filter

          Location : query

          Type : string

          Description : Optional. A [filter string](https://google.aip.dev/160) 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`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`

  • datamanager.accountTypes.accounts.userListGlobalLicenses.create

      Parameters :

        parent

          Type : string

          Required : Yes

          Location : path

          Description : Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+$

  • datamanager.accountTypes.accounts.userListGlobalLicenses.get

      Parameters :

        name

          Location : path

          Description : Required. The resource name of the user list global license.

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$

          Required : Yes

          Type : string

  • datamanager.accountTypes.accounts.userListGlobalLicenses.patch

      Parameters :

        name

          Required : Yes

          Type : string

          Description : Identifier. The resource name of the user list global license.

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$

          Location : path

        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.

          Location : query

          Type : string

          Format : google-fieldmask

  • datamanager.accountTypes.accounts.insights.retrieve

      Parameters :

        parent

          Required : Yes

          Pattern : ^accountTypes/[^/]+/accounts/[^/]+$

          Type : string

          Location : path

          Description : Required. The parent account that owns the user list. Format: `accountTypes/{account_type}/accounts/{account}`