Google Ads Data Manager V1 Client - Class Destination (0.1.0)

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

The Google product you're sending data to. For example, a Google Ads account.

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

Namespace

Google \ Ads \ DataManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ reference	string Optional. ID for this Destination resource, unique within the request. Use to reference this Destination in the IngestEventsRequest and IngestAudienceMembersRequest.
↳ login_account	ProductAccount Optional. The account used to make this API call. To add or remove data from the operating_account, this login_account must have write access to the operating_account. For example, a manager account of the operating_account, or an account with an established link to the operating_account.
↳ linked_account	ProductAccount Optional. An account that the calling user's login_account has access to, through an established account link. For example, a data partner's login_account might have access to a client's linked_account. The partner might use this field to send data from the linked_account to another operating_account.
↳ operating_account	ProductAccount Required. The account to send the data to or remove the data from.
↳ product_destination_id	string Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID.

getReference

Optional. ID for this Destination resource, unique within the request.

Use to reference this Destination in the IngestEventsRequest and IngestAudienceMembersRequest.

Returns
Type	Description
string

setReference

Optional. ID for this Destination resource, unique within the request.

Use to reference this Destination in the IngestEventsRequest and IngestAudienceMembersRequest.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLoginAccount

Optional. The account used to make this API call. To add or remove data from the operating_account, this login_account must have write access to the operating_account. For example, a manager account of the operating_account, or an account with an established link to the operating_account.

Returns
Type	Description
ProductAccount|null

hasLoginAccount

clearLoginAccount

setLoginAccount

Optional. The account used to make this API call. To add or remove data from the operating_account, this login_account must have write access to the operating_account. For example, a manager account of the operating_account, or an account with an established link to the operating_account.

Parameter
Name	Description
var	ProductAccount

Returns
Type	Description
$this

getLinkedAccount

Optional. An account that the calling user's login_account has access to, through an established account link. For example, a data partner's login_account might have access to a client's linked_account.

The partner might use this field to send data from the linked_account to another operating_account.

Returns
Type	Description
ProductAccount|null

hasLinkedAccount

clearLinkedAccount

setLinkedAccount

Optional. An account that the calling user's login_account has access to, through an established account link. For example, a data partner's login_account might have access to a client's linked_account.

The partner might use this field to send data from the linked_account to another operating_account.

Parameter
Name	Description
var	ProductAccount

Returns
Type	Description
$this

getOperatingAccount

Required. The account to send the data to or remove the data from.

Returns
Type	Description
ProductAccount|null

hasOperatingAccount

clearOperatingAccount

setOperatingAccount

Required. The account to send the data to or remove the data from.

Parameter
Name	Description
var	ProductAccount

Returns
Type	Description
$this

getProductDestinationId

Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID.

Returns
Type	Description
string

setProductDestinationId

Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID.

Parameter
Name	Description
var	string

Returns
Type	Description
$this