GoogleAdsGoogleadsV25Services__MutateAccountLinkRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-ads/json-schema/google-ads-google-ads-googleads-v25-services-mutate-account-link-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateAccountLinkRequest",
  "description": "Request message for AccountLinkService.MutateAccountLink.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-accountlinks-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateAccountLinkRequest",
  "type": "object",
  "properties": {
    "partialFailure": {
      "type": "boolean",
      "description": "If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false."
    },
    "operation": {
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__AccountLinkOperation",
      "description": "Required. The operation to perform on the link."
    },
    "validateOnly": {
      "type": "boolean",
      "description": "If true, the request is validated but not executed. Only errors are returned, not results."
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Resources__AccountLink": {
      "description": "Represents the data sharing connection between a Google Ads account and another account",
      "type": "object",
      "properties": {
        "type": {
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "THIRD_PARTY_APP_ANALYTICS"
          ],
          "type": "string",
          "description": "Output only. The type of the linked account.",
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "A link to provide third party app analytics data."
          ]
        },
        "status": {
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "The link is enabled.",
            "The link is removed/disabled.",
            "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.",
            "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.",
            "The link is rejected by the approver.",
            "The link is revoked by the user who requested the link."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "ENABLED",
            "REMOVED",
            "REQUESTED",
            "PENDING_APPROVAL",
            "REJECTED",
            "REVOKED"
          ],
          "type": "string",
          "description": "The status of the link."
        },
        "accountLinkId": {
          "description": "Output only. The ID of the link. This field is read only.",
          "type": "string",
          "format": "int64"
        },
        "thirdPartyAppAnalytics": {
          "description": "Immutable. A third party app analytics link.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__ThirdPartyAppAnalyticsLinkIdentifier"
        },
        "resourceName": {
          "description": "Immutable. Resource name of the account link. AccountLink resource names have the form: `customers/{customer_id}/accountLinks/{account_link_id}`",
          "type": "string"
        }
      }
    },
    "GoogleAdsGoogleadsV25Resources__ThirdPartyAppAnalyticsLinkIdentifier": {
      "type": "object",
      "properties": {
        "appAnalyticsProviderId": {
          "type": "string",
          "description": "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.",
          "format": "int64"
        },
        "appVendor": {
          "description": "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.",
          "type": "string",
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "Mobile app vendor for Apple app store.",
            "Mobile app vendor for Google app store."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "APPLE_APP_STORE",
            "GOOGLE_APP_STORE"
          ]
        },
        "appId": {
          "description": "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.",
          "type": "string"
        }
      },
      "description": "The identifiers of a Third Party App Analytics Link."
    },
    "GoogleAdsGoogleadsV25Services__AccountLinkOperation": {
      "type": "object",
      "properties": {
        "update": {
          "description": "Update operation: The account link is expected to have a valid resource name.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__AccountLink"
        },
        "updateMask": {
          "description": "FieldMask that determines which resource fields are modified in an update.",
          "type": "string",
          "format": "google-fieldmask"
        },
        "remove": {
          "description": "Remove operation: A resource name for the account link to remove is expected, in this format: `customers/{customer_id}/accountLinks/{account_link_id}`",
          "type": "string"
        }
      },
      "description": "A single update on an account link."
    }
  }
}