Google Ads Data Manager V1 Client - Class UpdateUserListRequest (0.2.0)

Reference documentation and code samples for the Google Ads Data Manager V1 Client class UpdateUserListRequest.

Request message for UpdateUserList.

Generated from protobuf message google.ads.datamanager.v1.UpdateUserListRequest

Namespace

Google \ Ads \ DataManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ user_list UserList

Required. The user list to update. The user list's name field is used to identify the user list to update. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
↳ update_mask Google\Protobuf\FieldMask

Optional. The list of fields to update.
↳ validate_only bool

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

getUserList

Required. The user list to update.

The user list's name field is used to identify the user list to update. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

Returns
Type Description
UserList|null

hasUserList

clearUserList

setUserList

Required. The user list to update.

The user list's name field is used to identify the user list to update. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

Parameter
Name Description
var UserList
Returns
Type Description
$this

getUpdateMask

Optional. The list of fields to update.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. The list of fields to update.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getValidateOnly

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

Returns
Type Description
bool

setValidateOnly

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

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
userList UserList

Required. The user list to update.

The user list's name field is used to identify the user list to update. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
updateMask Google\Protobuf\FieldMask

Optional. The list of fields to update.
Returns
Type Description
UpdateUserListRequest