Reference documentation and code samples for the Google Analytics Admin V1alpha Client class GoogleAdsLink.
A link between a GA4 property and a Google Ads account.
Generated from protobuf message google.analytics.admin.v1alpha.GoogleAdsLink
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. |
↳ customer_id |
string
Immutable. Google Ads customer ID. |
↳ can_manage_clients |
bool
Output only. If true, this link is for a Google Ads manager account. |
↳ ads_personalization_enabled |
Google\Protobuf\BoolValue
Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when this link was originally created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time when this link was last updated. |
↳ creator_email_address |
string
Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. |
getName
Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCustomerId
Immutable. Google Ads customer ID.
| Returns | |
|---|---|
| Type | Description |
string | |
setCustomerId
Immutable. Google Ads customer ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCanManageClients
Output only. If true, this link is for a Google Ads manager account.
| Returns | |
|---|---|
| Type | Description |
bool | |
setCanManageClients
Output only. If true, this link is for a Google Ads manager account.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAdsPersonalizationEnabled
Enable personalized advertising features with this integration.
Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null | |
hasAdsPersonalizationEnabled
clearAdsPersonalizationEnabled
getAdsPersonalizationEnabledValue
Returns the unboxed value from getAdsPersonalizationEnabled()
Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
| Returns | |
|---|---|
| Type | Description |
bool|null | |
setAdsPersonalizationEnabled
Enable personalized advertising features with this integration.
Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setAdsPersonalizationEnabledValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Time when this link was originally created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when this link was originally created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Time when this link was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when this link was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreatorEmailAddress
Output only. Email address of the user that created the link.
An empty string will be returned if the email address can't be retrieved.
| Returns | |
|---|---|
| Type | Description |
string | |
setCreatorEmailAddress
Output only. Email address of the user that created the link.
An empty string will be returned if the email address can't be retrieved.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |