REST Resource: customers.adsDataLinks

• Resource: AdsDataLink
  • JSON representation
• Entity
  • JSON representation
• EntityType
• Platform
• Metric
• Methods

Resource: AdsDataLink

Represents an advertising data link.

JSON representation
{ "name": string, "linkedEntity": { object(Entity) }, "parentEntity": { object(Entity) }, "childEntities": [ { object(Entity) } ], "platform": enum(Platform), "customerLink": { object(CustomerLink) }, "status": enum(LinkStatus), "createTime": string, "updateTime": string, "vendorClientId": string, "metrics": [ enum(Metric) ] }

Fields
name	string Name that uniquely identifies an AdsDataLink resource. It has the form customers/[customerId]/adsDataLinks/[resource_id]. The resource ID is generated by the server.
linkedEntity	object(Entity) Entity linked through this AdsDataLink.
parentEntity	object(Entity) Related parent entity, if any. If the linked entity is a Google Ads campaign, this field will contain a corresponding Google Ads customer to which the campaign belongs.
childEntities[]	object(Entity) Related child entities, if any. If the linked entity is a Google Ads customer that corresponds to a customer-manager link, then childEntities will include a fully expanded set of Google Ads customers with data imported into Ads Data Hub through this link.
platform	enum(Platform) Advertising platform associated with the linked entity.
customerLink	object(CustomerLink) Customer link through which the linked data can be accessed. Only name, customer ID, and displayName are populated.
status	enum(LinkStatus) Status of the data link.
createTime	string (Timestamp format) Time the link was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
updateTime	string (Timestamp format) Time the link status was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
vendorClientId	string (int64 format) Vendor client ID, if any.
metrics[]	enum(Metric) Metrics accessible through this data link. If empty, no metric restrictions are applied. This field is currently only supported for Google Ads campaign-level links.

Entity

Represents an advertising entity that can be linked to an Ads Data Hub customer.

JSON representation
{ "entityId": string, "displayName": string, "type": enum(EntityType) }

Fields
entityId	string (int64 format) Entity ID. The value listed here is dependent on the entity type.
displayName	string Entity display name.
type	enum(EntityType) Type of linked entity.

EntityType

Supported advertising entities.

Enums
ENTITY_TYPE_UNSPECIFIED	Unspecified entity type.
GOOGLE_ADS_CUSTOMER	A Google Ads customer. The entityId corresponds to [Customer.id][https://developers.google.com/google-ads/api/reference/rpc/google.ads.googleads.v0.resources#customer] in the Google Ads API.
GOOGLE_ADS_CAMPAIGN	A Google Ads campaign. The entityId corresponds to [Campaign.id][https://developers.google.com/google-ads/api/reference/rpc/google.ads.googleads.v0.resources#campaign] in the Google Ads API.
GMP_CM_ACCOUNT	A Google Marketing Platform Campaign Manager account. The entityId corresponds to [Accounts.id][https://developers.google.com/doubleclick-advertisers/v3.3/accounts]
GMP_CM_FLOODLIGHT	A Campaign Manager floodlight account. The entityId corresponds to [FloodlightConfigurations.accountId][https://developers.google.com/doubleclick-advertisers/v3.3/floodlightConfigurations]
GMP_DV360_PARTNER	A Display & Video 360 partner ID. The entityId is a DV360 partner ID.
GMP_DV360_ADVERTISER	A Display & Video 360 advertiser ID. The entityId is a DV360 advertiser ID.

Platform

Supported advertising platforms.

Enums
PLATFORM_UNSPECIFIED	Unspecified platform.
GOOGLE_ADS	The entity is associated with Google Ads.
GOOGLE_MARKETING_PLATFORM	The entity is associated with Google Marketing Platform.

Metric

Metrics that can be exposed through ad data links.

Enums
METRIC_UNSPECIFIED	Unspecified metric.
BRAND_LIFT	The link allows access to Brand Lift data, if available.
BRAND_SAFETY	The link allows access to brand safety data, if available.
REACH	The link allows access to reach data, if available.
VIEWABILITY	The link allows access to viewability data, if available.

Methods
list	Lists links between the specified customer and other Google advertising entities.