Google Ads Data Manager V1 Client - Class PartnerLink (0.6.0)

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

A partner link between an owning account and a partner account.

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

Namespace

Google \ Ads \ DataManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
`↳ partner_link_id`	`string` Output only. The partner link ID.
`↳ owning_account`	`ProductAccount` Required. The owning account granting access to the partner account.
`↳ partner_account`	`ProductAccount` Required. The partner account granted access by the owning account.
`↳ feature_set`	`int` Optional. Immutable. The set of features supported for the partner link. If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT.
`↳ partner_customer_account`	`PartnerCustomerAccount` Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set.
`↳ partner_link_metadata`	`PartnerLinkMetadata` Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT.

getName

Identifier. The name of the partner link.

Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

Returns
Type	Description
`string`

setName

Identifier. The name of the partner link.

Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPartnerLinkId

Output only. The partner link ID.

Returns
Type	Description
`string`

setPartnerLinkId

Output only. The partner link ID.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOwningAccount

Required. The owning account granting access to the partner account.

Returns
Type	Description
`ProductAccount\|null`

hasOwningAccount

clearOwningAccount

setOwningAccount

Required. The owning account granting access to the partner account.

Parameter
Name	Description
`var`	`ProductAccount`

Returns
Type	Description
`$this`

getPartnerAccount

Required. The partner account granted access by the owning account.

Returns
Type	Description
`ProductAccount\|null`

hasPartnerAccount

clearPartnerAccount

setPartnerAccount

Required. The partner account granted access by the owning account.

Parameter
Name	Description
`var`	`ProductAccount`

Returns
Type	Description
`$this`

getFeatureSet

Optional. Immutable. The set of features supported for the partner link.

If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT.

Returns
Type	Description
`int`	Enum of type FeatureSet.

setFeatureSet