Represents a Company.
Package
@google-ads/admanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.admanager.v1.ICompany);Constructs a new Company.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICompany
Properties to set |
Properties
_primaryContact
public _primaryContact?: "primaryContact";Company _primaryContact.
address
public address: string;Company address.
appliedLabels
public appliedLabels: google.ads.admanager.v1.IAppliedLabel[];Company appliedLabels.
appliedTeams
public appliedTeams: string[];Company appliedTeams.
comment
public comment: string;Company comment.
companyId
public companyId: (number|Long|string);Company companyId.
creditStatus
public creditStatus: (google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus|keyof typeof google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus);Company creditStatus.
displayName
public displayName: string;Company displayName.
public email: string;Company email.
externalId
public externalId: string;Company externalId.
fax
public fax: string;Company fax.
name
public name: string;Company name.
phone
public phone: string;Company phone.
primaryContact
public primaryContact?: (string|null);Company primaryContact.
thirdPartyCompanyId
public thirdPartyCompanyId: (number|Long|string);Company thirdPartyCompanyId.
type
public type: (google.ads.admanager.v1.CompanyTypeEnum.CompanyType|keyof typeof google.ads.admanager.v1.CompanyTypeEnum.CompanyType);Company type.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Company updateTime.
Methods
create(properties)
public static create(properties?: google.ads.admanager.v1.ICompany): google.ads.admanager.v1.Company;Creates a new Company instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICompany
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Company |
Company instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.Company;Decodes a Company 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 |
Company |
Company |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.Company;Decodes a Company message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Company |
Company |
encode(message, writer)
public static encode(message: google.ads.admanager.v1.ICompany, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Company message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICompany
Company 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.admanager.v1.ICompany, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Company message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICompany
Company 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.admanager.v1.Company;Creates a Company 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 |
Company |
Company |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Company
| 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 Company to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.admanager.v1.Company, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Company message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Company
Company |
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 Company message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|