REST Resource: customers.adsDataLinks

AI-generated Key Takeaways

• AdsDataLink represents a link between an Ads Data Hub customer and an advertising entity.

• An Entity can be various types of advertising entities such as Google Ads customers or campaigns, and Display & Video 360 partners or advertisers.

• The Platform field indicates the advertising platform associated with the linked entity, such as Google Ads or Google Marketing Platform.

• Metrics and GmpExportScopes specify what kind of data is accessible or exportable through the data link.

• Methods are available to batch approve or reject pending ads data links and list existing links for a customer.

• Resource: AdsDataLink
  • JSON representation
• Entity
  • JSON representation
• EntityType
• Platform
• Metric
• GmpExportScope
• 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) ], "gmpExportScopes": [ enum (GmpExportScope) ] }

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, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime	string (Timestamp format) Time the link status was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
vendorClientId	string 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 singlar, and only supported when link entity type is GOOGLE_ADS_CAMPAIGN or YT_RESERVE_LINE_ITEM.
gmpExportScopes[]	enum (GmpExportScope) Types of data that will be exported for Display & Video 360 links. Only populated when platform is GOOGLE_MARKETING_PLATFORM. If empty then unspecified and any combination of these may be available.

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
GOOGLE_ADS_CAMPAIGN	A Google Ads campaign. The entityId corresponds to Campaign.id in the Google Ads API.
GMP_CM_ACCOUNT	A Campaign Manager 360 account. The entityId corresponds to Accounts.id in the Campaign Manager 360 API.
GMP_CM_FLOODLIGHT	A Campaign Manager 360 floodlight account. The entityId corresponds to FloodlightConfigurations.accountId in the Campaign Manager 360 API.
GMP_DV360_PARTNER	A Display & Video 360 partner ID. The entityId is a Display & Video 360 partner ID.
GMP_DV360_ADVERTISER	A Display & Video 360 advertiser ID. The entityId is a Display & Video 360 advertiser ID.
GMP_DV360_ORDER	A Display & Video 360 order ID. The entityId is a Display & Video 360 order ID.
GMP_DV360_LINE_ITEM	A Display & Video 360 line item ID. The entityId is a Display & Video 360 line item ID.
YT_RESERVE_ORDER	A YouTube Reserve order ID. The entityId corresponds to Order.id in the Google Ad Manager API.
YT_RESERVE_LINE_ITEM	A YouTube Reserve line item. The entityId corresponds to LineItem.id in the Google Ad Manager API.
VENDOR_CLIENT_ID_REGISTRATION	A Vendor Client ID that is manually registered by a third-party ad tech vendor to provide third-party measurements.
GOOGLE_AD_MANAGER_ORDER	A Google Ad Manager order ID. The entityId corresponds to Order.id in the Google Ad Manager API.
GOOGLE_AD_MANAGER_LINE_ITEM	A Google Ad Manager line item. The entityId corresponds to LineItem.id in the Google Ad Manager API.

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.
YOUTUBE_RESERVE	The entity is associated with YouTube Reserve.
GOOGLE_AD_MANAGER	The entity is associated with Google Ad Manager.
FREEWHEEL	The entity is associated with FreeWheel.

Metric

Metrics that can be exposed through ad data links.

Enums
METRIC_UNSPECIFIED	Unspecified metric.
BRAND_LIFT	Metric corresponding to Brand Lift.
BRAND_SAFETY	Metric corresponding to Brand Safety.
REACH	Metric corresponding to Reach, where the customer is the advertiser.
VIEWABILITY	Metric corresponding to Viewability, where the customer is the advertiser.
PUBLISHER_REACH	Metric corresponding to Reach, where the customer is the publisher/content provider.
PUBLISHER_VIEWABILITY	Metric corresponding to Viewability, where the customer is the publisher/content provider.

GmpExportScope

Different types of data that can be exported for GMP links.

Enums
GMP_EXPORT_SCOPE_UNSPECIFIED	Unspecified scope.
GMP_EXPORT_SCOPE_YT_TRUEVIEW	Should export Display & Video 360 YouTube TrueView data.
GMP_EXPORT_SCOPE_DT	Should export Data Transfer data.

Methods
batchApprove	Approve a list of pending ads data links.
batchReject	Reject a list of pending ads data links.
list	Lists links between the specified customer and other Google advertising entities.