Data Manager API . accountTypes . accounts . userLists

close()

Close httplib2 connections.

create(parent, body=None, validateOnly=None, x__xgafv=None)

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

Args:
  parent: string, Required. The parent account where this user list will be created. Format: accountTypes/{account_type}/accounts/{account} (required)
  body: object, The request body.
    The object takes the form of:

{ # A user list resource.
  "accessReason": "A String", # Output only. The reason this account has been granted access to the list.
  "accountAccessStatus": "A String", # 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`.
  "closingReason": "A String", # Output only. The reason why this user list membership status is closed.
  "description": "A String", # Optional. A description of the user list.
  "displayName": "A String", # Required. The display name of the user list.
  "id": "A String", # Output only. The unique ID of the user list.
  "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data.
    "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data
      "matchRatePercentage": 42, # Output only. Match rate for customer match user lists.
    },
    "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`.
      "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
      "keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
    },
    "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
      "advertiserIdentifierCount": "A String", # 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.
      "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
      "matchRatePercentage": 42, # Required. 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.
      "publisherId": "A String", # 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.
      "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
    },
    "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
      "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
      "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience.
    },
    "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
      "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched).
      "syncStatus": "A String", # Output only. Sync status of the user list.
    },
    "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list.
      "A String",
    ],
    "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
    },
  },
  "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
  "membershipDuration": "A String", # 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.
  "membershipStatus": "A String", # Optional. Membership status of this user list.
  "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
  "readOnly": True or False, # Output only. An option that indicates if a user may edit a list.
  "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks.
    "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network.
    "searchNetworkMembersCount": "A String", # 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.
  },
  "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks.
    "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network.
    "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network.
  },
}

  validateOnly: boolean, Optional. If true, the request is validated but not executed.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A user list resource.
  "accessReason": "A String", # Output only. The reason this account has been granted access to the list.
  "accountAccessStatus": "A String", # 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`.
  "closingReason": "A String", # Output only. The reason why this user list membership status is closed.
  "description": "A String", # Optional. A description of the user list.
  "displayName": "A String", # Required. The display name of the user list.
  "id": "A String", # Output only. The unique ID of the user list.
  "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data.
    "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data
      "matchRatePercentage": 42, # Output only. Match rate for customer match user lists.
    },
    "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`.
      "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
      "keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
    },
    "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
      "advertiserIdentifierCount": "A String", # 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.
      "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
      "matchRatePercentage": 42, # Required. 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.
      "publisherId": "A String", # 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.
      "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
    },
    "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
      "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
      "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience.
    },
    "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
      "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched).
      "syncStatus": "A String", # Output only. Sync status of the user list.
    },
    "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list.
      "A String",
    ],
    "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
    },
  },
  "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
  "membershipDuration": "A String", # 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.
  "membershipStatus": "A String", # Optional. Membership status of this user list.
  "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
  "readOnly": True or False, # Output only. An option that indicates if a user may edit a list.
  "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks.
    "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network.
    "searchNetworkMembersCount": "A String", # 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.
  },
  "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks.
    "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network.
    "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network.
  },
}

delete(name, validateOnly=None, x__xgafv=None)

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

Args:
  name: string, Required. The name of the user list to delete. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} (required)
  validateOnly: boolean, Optional. If true, the request is validated but not executed.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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); }
}

get(name, x__xgafv=None)

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

Args:
  name: string, Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A user list resource.
  "accessReason": "A String", # Output only. The reason this account has been granted access to the list.
  "accountAccessStatus": "A String", # 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`.
  "closingReason": "A String", # Output only. The reason why this user list membership status is closed.
  "description": "A String", # Optional. A description of the user list.
  "displayName": "A String", # Required. The display name of the user list.
  "id": "A String", # Output only. The unique ID of the user list.
  "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data.
    "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data
      "matchRatePercentage": 42, # Output only. Match rate for customer match user lists.
    },
    "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`.
      "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
      "keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
    },
    "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
      "advertiserIdentifierCount": "A String", # 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.
      "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
      "matchRatePercentage": 42, # Required. 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.
      "publisherId": "A String", # 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.
      "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
    },
    "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
      "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
      "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience.
    },
    "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
      "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched).
      "syncStatus": "A String", # Output only. Sync status of the user list.
    },
    "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list.
      "A String",
    ],
    "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
    },
  },
  "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
  "membershipDuration": "A String", # 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.
  "membershipStatus": "A String", # Optional. Membership status of this user list.
  "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
  "readOnly": True or False, # Output only. An option that indicates if a user may edit a list.
  "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks.
    "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network.
    "searchNetworkMembersCount": "A String", # 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.
  },
  "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks.
    "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network.
    "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network.
  },
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

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

Args:
  parent: string, Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account} (required)
  filter: string, 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`
  pageSize: integer, Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListUserLists.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "userLists": [ # The user lists from the specified account.
    { # A user list resource.
      "accessReason": "A String", # Output only. The reason this account has been granted access to the list.
      "accountAccessStatus": "A String", # 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`.
      "closingReason": "A String", # Output only. The reason why this user list membership status is closed.
      "description": "A String", # Optional. A description of the user list.
      "displayName": "A String", # Required. The display name of the user list.
      "id": "A String", # Output only. The unique ID of the user list.
      "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data.
        "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`.
          "dataSourceType": "A String", # Optional. Immutable. Source of the upload data
          "matchRatePercentage": 42, # Output only. Match rate for customer match user lists.
        },
        "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`.
          "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.
          "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
          "keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
        },
        "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
          "advertiserIdentifierCount": "A String", # 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.
          "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
          "matchRatePercentage": 42, # Required. 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.
          "publisherId": "A String", # 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.
          "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
        },
        "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
          "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
          "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience.
        },
        "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
          "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched).
          "syncStatus": "A String", # Output only. Sync status of the user list.
        },
        "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list.
          "A String",
        ],
        "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`.
          "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
        },
      },
      "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
      "membershipDuration": "A String", # 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.
      "membershipStatus": "A String", # Optional. Membership status of this user list.
      "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
      "readOnly": True or False, # Output only. An option that indicates if a user may edit a list.
      "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks.
        "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network.
        "searchNetworkMembersCount": "A String", # 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.
      },
      "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks.
        "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network.
        "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network.
      },
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)

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

Args:
  name: string, Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} (required)
  body: object, The request body.
    The object takes the form of:

{ # A user list resource.
  "accessReason": "A String", # Output only. The reason this account has been granted access to the list.
  "accountAccessStatus": "A String", # 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`.
  "closingReason": "A String", # Output only. The reason why this user list membership status is closed.
  "description": "A String", # Optional. A description of the user list.
  "displayName": "A String", # Required. The display name of the user list.
  "id": "A String", # Output only. The unique ID of the user list.
  "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data.
    "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data
      "matchRatePercentage": 42, # Output only. Match rate for customer match user lists.
    },
    "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`.
      "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
      "keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
    },
    "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
      "advertiserIdentifierCount": "A String", # 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.
      "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
      "matchRatePercentage": 42, # Required. 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.
      "publisherId": "A String", # 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.
      "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
    },
    "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
      "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
      "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience.
    },
    "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
      "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched).
      "syncStatus": "A String", # Output only. Sync status of the user list.
    },
    "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list.
      "A String",
    ],
    "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
    },
  },
  "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
  "membershipDuration": "A String", # 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.
  "membershipStatus": "A String", # Optional. Membership status of this user list.
  "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
  "readOnly": True or False, # Output only. An option that indicates if a user may edit a list.
  "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks.
    "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network.
    "searchNetworkMembersCount": "A String", # 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.
  },
  "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks.
    "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network.
    "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network.
  },
}

  updateMask: string, Optional. The list of fields to update.
  validateOnly: boolean, Optional. If true, the request is validated but not executed.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A user list resource.
  "accessReason": "A String", # Output only. The reason this account has been granted access to the list.
  "accountAccessStatus": "A String", # 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`.
  "closingReason": "A String", # Output only. The reason why this user list membership status is closed.
  "description": "A String", # Optional. A description of the user list.
  "displayName": "A String", # Required. The display name of the user list.
  "id": "A String", # Output only. The unique ID of the user list.
  "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data.
    "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data
      "matchRatePercentage": 42, # Output only. Match rate for customer match user lists.
    },
    "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`.
      "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
      "keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
    },
    "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
      "advertiserIdentifierCount": "A String", # 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.
      "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
      "matchRatePercentage": 42, # Required. 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.
      "publisherId": "A String", # 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.
      "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
    },
    "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
      "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
      "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience.
    },
    "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
      "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched).
      "syncStatus": "A String", # Output only. Sync status of the user list.
    },
    "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list.
      "A String",
    ],
    "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`.
      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
    },
  },
  "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
  "membershipDuration": "A String", # 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.
  "membershipStatus": "A String", # Optional. Membership status of this user list.
  "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
  "readOnly": True or False, # Output only. An option that indicates if a user may edit a list.
  "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks.
    "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network.
    "searchNetworkMembersCount": "A String", # 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.
  },
  "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks.
    "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network.
    "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network.
  },
}