Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

AccountLink

JSON representation
AccountLinkStatus
LinkedAccountType
ThirdPartyAppAnalyticsLinkIdentifier
- JSON representation

Represents the data sharing connection between a Google Ads account and another account

JSON representation

JSON representation
{ "resourceName": string, "status": enum (`AccountLinkStatus`), "type": enum (`LinkedAccountType`), "accountLinkId": string, // Union field `linked_account` can be only one of the following: "thirdPartyAppAnalytics": { object (`ThirdPartyAppAnalyticsLinkIdentifier`) } // End of list of possible types for union field `linked_account`. }

{
  "resourceName": string,
  "status": enum (AccountLinkStatus),
  "type": enum (LinkedAccountType),
  "accountLinkId": string,

  // Union field linked_account can be only one of the following:
  "thirdPartyAppAnalytics": {
    object (ThirdPartyAppAnalyticsLinkIdentifier)
  }
  // End of list of possible types for union field linked_account.
}

Fields
`resourceName`	`string` Immutable. Resource name of the account link. AccountLink resource names have the form: `customers/{customerId}/accountLinks/{accountLinkId}`
`status`	`enum (AccountLinkStatus)` The status of the link.
`type`	`enum (LinkedAccountType)` Output only. The type of the linked account.
`accountLinkId`	`string (int64 format)` Output only. The ID of the link. This field is read only.
Union field `linked_account`. An account linked to this Google Ads account. `linked_account` can be only one of the following:
`thirdPartyAppAnalytics`	`object (ThirdPartyAppAnalyticsLinkIdentifier)` Immutable. A third party app analytics link.

AccountLinkStatus

Describes the possible statuses for a link between a Google Ads customer and another account.

Enums
`UNSPECIFIED`	Not specified.
`UNKNOWN`	Used for return value only. Represents value unknown in this version.
`ENABLED`	The link is enabled.
`REMOVED`	The link is removed/disabled.
`REQUESTED`	The link to the other account has been requested. A user on the other account may now approve the link by setting the status to ENABLED.
`PENDING_APPROVAL`	This link has been requested by a user on the other account. It may be approved by a user on this account by setting the status to ENABLED.
`REJECTED`	The link is rejected by the approver.
`REVOKED`	The link is revoked by the user who requested the link.

LinkedAccountType

Describes the possible link types between a Google Ads customer and another account.

Enums
`UNSPECIFIED`	Not specified.
`UNKNOWN`	Used for return value only. Represents value unknown in this version.
`THIRD_PARTY_APP_ANALYTICS`	A link to provide third party app analytics data.

ThirdPartyAppAnalyticsLinkIdentifier

The identifiers of a Third Party App Analytics Link.

JSON representation
{ "appVendor": enum (`MobileAppVendor`), "appAnalyticsProviderId": string, "appId": string }

Fields

Fields
`appVendor`	`enum (MobileAppVendor)` Immutable. The vendor of the app. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
`appAnalyticsProviderId`	`string (int64 format)` Immutable. The ID of the app analytics provider. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
`appId`	`string` Immutable. A string that uniquely identifies a mobile application from which the data was collected to the Google Ads API. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, "422689480" for "Gmail" whose App Store link is https://apps.apple.com/us/app/gmail-email-by-google/id422689480). For Android, the ID string is the application's package name (for example, "com.google.android.gm" for "Gmail" given Google Play link https://play.google.com/store/apps/details?id=com.google.android.gm) This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.

appVendor

enum (MobileAppVendor)

Immutable. The vendor of the app. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.

appAnalyticsProviderId

string (int64 format)

Immutable. The ID of the app analytics provider. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.

appId

string

Immutable. A string that uniquely identifies a mobile application from which the data was collected to the Google Ads API. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, "422689480" for "Gmail" whose App Store link is https://apps.apple.com/us/app/gmail-email-by-google/id422689480). For Android, the ID string is the application's package name (for example, "com.google.android.gm" for "Gmail" given Google Play link https://play.google.com/store/apps/details?id=com.google.android.gm) This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.