Represents a UserList.
Implements
Package
@google-ads/datamanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.datamanager.v1.IUserList);Constructs a new UserList.
| Parameter | |
|---|---|
| Name | Description |
properties |
IUserList
Properties to set |
Properties
accessReason
public accessReason: (google.ads.datamanager.v1.UserList.AccessReason|keyof typeof google.ads.datamanager.v1.UserList.AccessReason);UserList accessReason.
accountAccessStatus
public accountAccessStatus?: (google.ads.datamanager.v1.UserList.AccessStatus|keyof typeof google.ads.datamanager.v1.UserList.AccessStatus|null);UserList accountAccessStatus.
closingReason
public closingReason?: (google.ads.datamanager.v1.UserList.ClosingReason|keyof typeof google.ads.datamanager.v1.UserList.ClosingReason|null);UserList closingReason.
description
public description?: (string|null);UserList description.
displayName
public displayName?: (string|null);UserList displayName.
id
public id: (number|Long|string);UserList id.
ingestedUserListInfo
public ingestedUserListInfo?: (google.ads.datamanager.v1.IIngestedUserListInfo|null);UserList ingestedUserListInfo.
integrationCode
public integrationCode?: (string|null);UserList integrationCode.
membershipDuration
public membershipDuration?: (google.protobuf.IDuration|null);UserList membershipDuration.
membershipStatus
public membershipStatus?: (google.ads.datamanager.v1.UserList.MembershipStatus|keyof typeof google.ads.datamanager.v1.UserList.MembershipStatus|null);UserList membershipStatus.
name
public name: string;UserList name.
readOnly
public readOnly: boolean;UserList readOnly.
sizeInfo
public sizeInfo?: (google.ads.datamanager.v1.ISizeInfo|null);UserList sizeInfo.
targetNetworkInfo
public targetNetworkInfo?: (google.ads.datamanager.v1.ITargetNetworkInfo|null);UserList targetNetworkInfo.
userListInfo
public userListInfo?: "ingestedUserListInfo";UserList userListInfo.
Methods
create(properties)
public static create(properties?: google.ads.datamanager.v1.IUserList): google.ads.datamanager.v1.UserList;Creates a new UserList instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IUserList
Properties to set |
| Returns | |
|---|---|
| Type | Description |
UserList |
UserList instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.datamanager.v1.UserList;Decodes a UserList message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
UserList |
UserList |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.datamanager.v1.UserList;Decodes a UserList message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
UserList |
UserList |
encode(message, writer)
public static encode(message: google.ads.datamanager.v1.IUserList, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified UserList message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IUserList
UserList message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.ads.datamanager.v1.IUserList, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified UserList message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IUserList
UserList message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.ads.datamanager.v1.UserList;Creates a UserList message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
UserList |
UserList |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for UserList
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this UserList to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.datamanager.v1.UserList, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a UserList message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
UserList
UserList |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a UserList message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|