Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Google Ads Ad Manager V1 Client - Class Company (0.7.0)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class Company.

The Company resource.

Generated from protobuf message google.ads.admanager.v1.Company

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The resource name of the Company. Format: `networks/{network_code}/companies/{company_id}`
`↳ company_id`	`int\|string` Output only. Deprecated: Company ID.
`↳ display_name`	`string` Required. The display name of the Company. This value has a maximum length of 127 characters.
`↳ type`	`int` Required. The type of the Company.
`↳ address`	`string` Optional. The address for the Company. This value has a maximum length of 1024 characters.
`↳ email`	`string` Optional. The email for the Company. This value has a maximum length of 128 characters.
`↳ fax`	`string` Optional. The fax number for the Company. This value has a maximum length of 63 characters.
`↳ phone`	`string` Optional. The phone number for the Company. This value has a maximum length of 63 characters.
`↳ external_id`	`string` Optional. The external ID for the Company. This value has a maximum length of 255 characters.
`↳ comment`	`string` Optional. Comments about the Company. This value has a maximum length of 1024 characters.
`↳ credit_status`	`int` Optional. The credit status of the Company. This attribute defaults to CompanyCreditStatus.ACTIVE if basic settings are enabled and CompanyCreditStatus.ON_HOLD if advance settings are enabled.
`↳ applied_labels`	`array<AppliedLabel>` Optional. The labels that are directly applied to the Company.
`↳ primary_contact`	`string` Optional. The resource names of primary Contact of the Company. Format: "networks/{network_code}/contacts/{contact_id}"
`↳ applied_teams`	`string[]` Optional. The resource names of Teams that are directly associated with the Company. Format: "networks/{network_code}/teams/{team_id}"
`↳ third_party_company_id`	`int\|string` Optional. The ID of the Google-recognized canonicalized form of the Company.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The time the Company was last modified.

getName

Identifier. The resource name of the Company. Format: networks/{network_code}/companies/{company_id}

Returns
Type	Description
`string`

setName

Identifier. The resource name of the Company. Format: networks/{network_code}/companies/{company_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCompanyId

Output only. Deprecated: Company ID.

Returns
Type	Description
`int\|string`

hasCompanyId

clearCompanyId

setCompanyId

Output only. Deprecated: Company ID.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getDisplayName

Required. The display name of the Company.

This value has a maximum length of 127 characters.

Returns
Type	Description
`string`

hasDisplayName

clearDisplayName

setDisplayName

Required. The display name of the Company.

This value has a maximum length of 127 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getType

Required. The type of the Company.

Returns
Type	Description
`int`

hasType

clearType

setType

Required. The type of the Company.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getAddress

Optional. The address for the Company.

This value has a maximum length of 1024 characters.

Returns
Type	Description
`string`

hasAddress

clearAddress

setAddress

Optional. The address for the Company.

This value has a maximum length of 1024 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEmail

Optional. The email for the Company.

This value has a maximum length of 128 characters.

Returns
Type	Description
`string`

hasEmail

clearEmail

setEmail

Optional. The email for the Company.

This value has a maximum length of 128 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFax

Optional. The fax number for the Company.

This value has a maximum length of 63 characters.

Returns
Type	Description
`string`

hasFax

clearFax

setFax

Optional. The fax number for the Company.

This value has a maximum length of 63 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPhone

Optional. The phone number for the Company.

This value has a maximum length of 63 characters.

Returns
Type	Description
`string`

hasPhone

clearPhone

setPhone

Optional. The phone number for the Company.

This value has a maximum length of 63 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getExternalId

Optional. The external ID for the Company.

This value has a maximum length of 255 characters.

Returns
Type	Description
`string`

hasExternalId

clearExternalId

setExternalId

Optional. The external ID for the Company.

This value has a maximum length of 255 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getComment

Optional. Comments about the Company.

This value has a maximum length of 1024 characters.

Returns
Type	Description
`string`

hasComment

clearComment

setComment

Optional. Comments about the Company.

This value has a maximum length of 1024 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreditStatus

Optional. The credit status of the Company.

This attribute defaults to CompanyCreditStatus.ACTIVE if basic settings are enabled and CompanyCreditStatus.ON_HOLD if advance settings are enabled.

Returns
Type	Description
`int`

hasCreditStatus

clearCreditStatus

setCreditStatus

Optional. The credit status of the Company.

This attribute defaults to CompanyCreditStatus.ACTIVE if basic settings are enabled and CompanyCreditStatus.ON_HOLD if advance settings are enabled.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getAppliedLabels

Optional. The labels that are directly applied to the Company.

Returns
Type	Description
`Google\Protobuf\RepeatedField<AppliedLabel>`

setAppliedLabels

Optional. The labels that are directly applied to the Company.

Parameter
Name	Description
`var`	`array<AppliedLabel>`

Returns
Type	Description
`$this`

getPrimaryContact

Optional. The resource names of primary Contact of the Company. Format: "networks/{network_code}/contacts/{contact_id}"

Returns
Type	Description
`string`

hasPrimaryContact

clearPrimaryContact

setPrimaryContact

Optional. The resource names of primary Contact of the Company. Format: "networks/{network_code}/contacts/{contact_id}"

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAppliedTeams

Optional. The resource names of Teams that are directly associated with the Company. Format: "networks/{network_code}/teams/{team_id}"

Returns
Type	Description
`Google\Protobuf\RepeatedField<string>`

setAppliedTeams

Optional. The resource names of Teams that are directly associated with the Company. Format: "networks/{network_code}/teams/{team_id}"

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getThirdPartyCompanyId

Optional. The ID of the Google-recognized canonicalized form of the Company.

Returns
Type	Description
`int\|string`

hasThirdPartyCompanyId

clearThirdPartyCompanyId

setThirdPartyCompanyId

Optional. The ID of the Google-recognized canonicalized form of the Company.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The time the Company was last modified.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the Company was last modified.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`