REST Resource: accountTypes.accounts.partnerLinks

• Resource: PartnerLink
  • JSON representation
• ProductAccount
  • JSON representation
• Product
• AccountType
• FeatureSet
• PartnerCustomerAccount
  • JSON representation
• PartnerLinkMetadata
  • JSON representation
• Methods

Resource: PartnerLink

A partner link between an owning account and a partner account.

JSON representation
{ "name": string, "partnerLinkId": string, "owningAccount": { object (ProductAccount) }, "partnerAccount": { object (ProductAccount) }, "featureSet": enum (FeatureSet), "partnerCustomerAccount": { object (PartnerCustomerAccount) }, "partnerLinkMetadata": { object (PartnerLinkMetadata) } }

Fields
name	string Identifier. The name of the partner link. Format: accountTypes/{accountType}/accounts/{account}/partnerLinks/{partnerLink}
partnerLinkId	string Output only. The partner link ID.
owningAccount	object (ProductAccount) Required. The owning account granting access to the partner account.
partnerAccount	object (ProductAccount) Required. The partner account granted access by the owning account.
featureSet	enum (FeatureSet) Optional. Immutable. The set of features supported for the partner link. If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT.
partnerCustomerAccount	object (PartnerCustomerAccount) Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set.
partnerLinkMetadata	object (PartnerLinkMetadata) Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT.

ProductAccount

Represents a specific account.

JSON representation
{ "product": enum (Product), "accountId": string, "accountType": enum (AccountType) }

Fields
product (deprecated)	enum (Product) This item is deprecated! Deprecated. Use accountType instead.
accountId	string Required. The ID of the account. For example, your Google Ads account ID.
accountType	enum (AccountType) Required. The type of the account. For example, GOOGLE_ADS. Either accountType or the deprecated product is required. If both are set, the values must match.

Product

This item is deprecated!

Deprecated. Use AccountType instead. Represents a specific Google product.

Enums
PRODUCT_UNSPECIFIED	Unspecified product. Should never be used.
GOOGLE_ADS	Google Ads.
DISPLAY_VIDEO_PARTNER	Display & Video 360 partner.
DISPLAY_VIDEO_ADVERTISER	Display & Video 360 advertiser.
DATA_PARTNER	Data Partner.

AccountType

Represents Google account types. Used to locate accounts and destinations.

Enums
ACCOUNT_TYPE_UNSPECIFIED	Unspecified product. Should never be used.
GOOGLE_ADS	Google Ads.
DISPLAY_VIDEO_PARTNER	Display & Video 360 partner.
DISPLAY_VIDEO_ADVERTISER	Display & Video 360 advertiser.
DATA_PARTNER	Data Partner.
GOOGLE_ANALYTICS_PROPERTY	Google Analytics.
GOOGLE_AD_MANAGER_AUDIENCE_LINK	Google Ad Manager audience link.
FLOODLIGHT_CONFIG	Floodlight configuration.

FeatureSet

The set of supported features for a partner link.

Enums
FEATURE_SET_UNSPECIFIED	Unspecified feature set. If unspecified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT.
FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT	Indicates a link used for audience and event management.
FEATURE_SET_AD_EVENT_MANAGEMENT	Indicates a link used for ad event management.

PartnerCustomerAccount

Represents a customer account in the partner's system.

JSON representation
{ "accountId": string, "accountName": string, "accountType": string }

Fields
accountId	string Required. The identifier of the customer account in the partner's ID space.
accountName	string Optional. The name of the account.
accountType	string Optional. The type of the account. Can be used to distinguish between advertiser accounts and business level accounts, for example.

PartnerLinkMetadata

Represents metadata associated with a partner link.

JSON representation
{ "implicitAccounts": [ { object (PartnerCustomerAccount) } ] }

Fields
implicitAccounts[]	object (PartnerCustomerAccount) Optional. The list of implicit accounts.

Methods
create	Creates a partner link for the given account.
delete	Deletes a partner link for the given account.
search	Searches for all partner links to and from a given account.