Google Analytics Admin V1alpha Client - Class SearchAds360Link (0.19.0)

Version 0.19.0

• 0.24.1 (latest)
• 0.24.0
• 0.23.0
• 0.22.5
• 0.20.0
• 0.19.0
• 0.18.1
• 0.17.0
• 0.16.0
• 0.15.1
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.2

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class SearchAds360Link.

A link between a GA4 property and a Search Ads 360 entity.

Generated from protobuf message google.analytics.admin.v1alpha.SearchAds360Link

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID
↳ advertiser_id	string Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked.
↳ campaign_data_sharing_enabled	Google\Protobuf\BoolValue Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.
↳ cost_data_sharing_enabled	Google\Protobuf\BoolValue Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.
↳ advertiser_display_name	string Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource.
↳ ads_personalization_enabled	Google\Protobuf\BoolValue Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.
↳ site_stats_sharing_enabled	Google\Protobuf\BoolValue Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true.

getName

Output only. The resource name for this SearchAds360Link resource.

Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID

Returns
Type	Description
string

setName

Output only. The resource name for this SearchAds360Link resource.

Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAdvertiserId

Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked.

Returns
Type	Description
string

setAdvertiserId

Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCampaignDataSharingEnabled

Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product.

If this field is not set on create, it will be defaulted to true.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasCampaignDataSharingEnabled

clearCampaignDataSharingEnabled

getCampaignDataSharingEnabledValue

Returns the unboxed value from getCampaignDataSharingEnabled()

Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.

Returns
Type	Description
bool|null

setCampaignDataSharingEnabled

Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product.

If this field is not set on create, it will be defaulted to true.

Parameter
Name	Description
var	Google\Protobuf\BoolValue

Returns
Type	Description
$this

setCampaignDataSharingEnabledValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this

getCostDataSharingEnabled

Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product.

If this field is not set on create, it will be defaulted to true.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasCostDataSharingEnabled

clearCostDataSharingEnabled

getCostDataSharingEnabledValue

Returns the unboxed value from getCostDataSharingEnabled()

Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.

Returns
Type	Description
bool|null

setCostDataSharingEnabled

Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product.

If this field is not set on create, it will be defaulted to true.

Parameter
Name	Description
var	Google\Protobuf\BoolValue

Returns
Type	Description
$this

setCostDataSharingEnabledValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this

getAdvertiserDisplayName

Output only. The display name of the Search Ads 360 Advertiser.

Allows users to easily identify the linked resource.

Returns
Type	Description
string

setAdvertiserDisplayName

Output only. The display name of the Search Ads 360 Advertiser.

Allows users to easily identify the linked resource.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAdsPersonalizationEnabled

Enables personalized advertising features with this integration.

If this field is not set on create, it will be defaulted to true.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasAdsPersonalizationEnabled

clearAdsPersonalizationEnabled

getAdsPersonalizationEnabledValue

Returns the unboxed value from getAdsPersonalizationEnabled()

Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.

Returns
Type	Description
bool|null

setAdsPersonalizationEnabled

Enables personalized advertising features with this integration.

If this field is not set on create, 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.

Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this

getSiteStatsSharingEnabled

Enables export of site stats with this integration.

If this field is not set on create, it will be defaulted to true.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasSiteStatsSharingEnabled

clearSiteStatsSharingEnabled

getSiteStatsSharingEnabledValue

Returns the unboxed value from getSiteStatsSharingEnabled()

Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true.

Returns
Type	Description
bool|null

setSiteStatsSharingEnabled

Enables export of site stats with this integration.

If this field is not set on create, it will be defaulted to true.

Parameter
Name	Description
var	Google\Protobuf\BoolValue

Returns
Type	Description
$this

setSiteStatsSharingEnabledValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true.

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this