Reference documentation and code samples for the Google Ads Ad Manager V1 Client class Partner.
The Partner resource.
Represents a publishing partner with established agreements to share inventory and revenue based on assignments. For more information, see Add publishing partner assignments.
Generated from protobuf message google.ads.admanager.v1.Partner
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the Partner. Format: |
↳ display_name |
string
Required. The display name of the Partner. |
↳ address |
string
Optional. The address for the Partner. This value has a maximum length of 1024 characters. |
↳ email |
string
Optional. The email for the Partner. This value has a maximum length of 128 characters. |
↳ fax |
string
Optional. The fax number for the Partner. This value has a maximum length of 63 characters. |
↳ phone |
string
Optional. The phone number for the Partner. This value has a maximum length of 63 characters. |
↳ external_id |
string
Optional. The external ID for the Partner. This value has a maximum length of 255 characters. |
↳ comment |
string
Optional. Comments about the Partner. This value has a maximum length of 1024 characters. |
↳ applied_labels |
array<AppliedLabel>
Optional. The labels that are directly applied to the Partner. |
↳ primary_contact |
string
Optional. The resource names of primary Contact of the Partner. Format: "networks/{network_code}/contacts/{contact_id}" |
↳ applied_teams |
string[]
Optional. The resource names of Teams that are directly associated with the Partner. Format: "networks/{network_code}/teams/{team_id}" |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time the Partner was last updated. |
↳ credit_status |
int
Optional. The credit status of the Partner. This attribute defaults to CompanyCreditStatus.ACTIVE if basic settings are enabled and CompanyCreditStatus.ON_HOLD if advance settings are enabled. |
getName
Identifier. The resource name of the
Partner. Format:
networks/{network_code}/partners/{partner_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the
Partner. Format:
networks/{network_code}/partners/{partner_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The display name of the Partner.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayName
clearDisplayName
setDisplayName
Required. The display name of the Partner.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAddress
Optional. The address for the Partner.
This value has a maximum length of 1024 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAddress
clearAddress
setAddress
Optional. The address for the Partner.
This value has a maximum length of 1024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEmail
Optional. The email for the Partner.
This value has a maximum length of 128 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasEmail
clearEmail
setEmail
Optional. The email for the Partner.
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 Partner.
This value has a maximum length of 63 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasFax
clearFax
setFax
Optional. The fax number for the Partner.
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 Partner.
This value has a maximum length of 63 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPhone
clearPhone
setPhone
Optional. The phone number for the Partner.
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 Partner.
This value has a maximum length of 255 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasExternalId
clearExternalId
setExternalId
Optional. The external ID for the Partner.
This value has a maximum length of 255 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComment
Optional. Comments about the Partner.
This value has a maximum length of 1024 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasComment
clearComment
setComment
Optional. Comments about the Partner.
This value has a maximum length of 1024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAppliedLabels
Optional. The labels that are directly applied to the Partner.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<AppliedLabel> |
|
setAppliedLabels
Optional. The labels that are directly applied to the Partner.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AppliedLabel>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrimaryContact
Optional. The resource names of primary Contact of the Partner. Format: "networks/{network_code}/contacts/{contact_id}"
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPrimaryContact
clearPrimaryContact
setPrimaryContact
Optional. The resource names of primary Contact of the Partner. 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 Partner.
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 Partner.
Format: "networks/{network_code}/teams/{team_id}"
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time the Partner was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time the Partner was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreditStatus
Optional. The credit status of the Partner.
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 Partner.
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 |
|