Google Marketing Platform Admin Analytics Account Links API

openapi: 3.2.0
info:
  title: Google Marketing Platform Admin API v1alpha Analytics………
  description: The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, and to set the service level of your GA4 properties.
  version: v1alpha
  contact:
    name: Google
    url: https://developers.google.com/analytics/devguides/config/gmp/v1
  license:
    name: Google APIs Terms of Service
    url: https://developers.google.com/terms
servers:
- url: https://marketingplatformadmin.googleapis.com
  description: Marketing Platform Admin API server
tags:
- name: AnalyticsAccountLinks
paths:
  /v1alpha/organizations/{organizationsId}/analyticsAccountLinks/{analyticsAccountLinksId}:setPropertyServiceLevel:
    post:
      operationId: setPropertyServiceLevel
      summary: marketingplatformadmin.organizations.analyticsAccountLinks.setPropertyServiceLev…
      description: Updates the service level for an Analytics property.
      tags:
      - AnalyticsAccountLinks
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+analyticsAccountLink}:setPropertyServiceLevel`.
      - name: analyticsAccountLinksId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+analyticsAccountLink}:setPropertyServiceLevel`.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetPropertyServiceLevelResponse'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.analyticsAccountLinks.setPropertyServiceLevel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetPropertyServiceLevelRequest'
  /v1alpha/organizations/{organizationsId}/analyticsAccountLinks:
    post:
      operationId: createAnalyticsAccountLink
      summary: marketingplatformadmin.organizations.analyticsAccountLinks.create
      description: Creates the link between the Analytics account and the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account to create the link. If the account is already linked to an organization, user needs to unlink the account from the current organization, then try link again.
      tags:
      - AnalyticsAccountLinks
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+parent}/analyticsAccountLinks`.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsAccountLink'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.analyticsAccountLinks.create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyticsAccountLink'
    get:
      operationId: listAnalyticsAccountLinks
      summary: marketingplatformadmin.organizations.analyticsAccountLinks.list
      description: Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.
      tags:
      - AnalyticsAccountLinks
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+parent}/analyticsAccountLinks`.
      - name: pageToken
        in: query
        required: false
        description: Optional. A page token, received from a previous ListAnalyticsAccountLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnalyticsAccountLinks` must match the call that provided the page token.
        schema:
          type: string
      - name: pageSize
        in: query
        required: false
        description: Optional. The maximum number of Analytics account links to return in one call. The service may return fewer than this value. If unspecified, at most 50 Analytics account links will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAnalyticsAccountLinksResponse'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.analyticsAccountLinks.list
  /v1alpha/organizations/{organizationsId}/analyticsAccountLinks/{analyticsAccountLinksId}:
    delete:
      operationId: deleteAnalyticsAccountLink
      summary: marketingplatformadmin.organizations.analyticsAccountLinks.delete
      description: Deletes the AnalyticsAccountLink, which detaches the Analytics account from the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account in order to delete the link.
      tags:
      - AnalyticsAccountLinks
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+name}`.
      - name: analyticsAccountLinksId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+name}`.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.analyticsAccountLinks.delete
components:
  schemas:
    SetPropertyServiceLevelResponse:
      type: object
      description: Response message for SetPropertyServiceLevel RPC.
      properties: {}
    ListAnalyticsAccountLinksResponse:
      type: object
      description: Response message for ListAnalyticsAccountLinks RPC.
      properties:
        analyticsAccountLinks:
          type: array
          description: Analytics account links in this organization.
          items:
            $ref: '#/components/schemas/AnalyticsAccountLink'
        nextPageToken:
          type: string
          description: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
    SetPropertyServiceLevelRequest:
      type: object
      description: Request message for SetPropertyServiceLevel RPC.
      properties:
        analyticsProperty:
          type: string
          description: 'Required. The Analytics property to change the ServiceLevel setting. This field is the name of the Google Analytics Admin API property resource. Format: analyticsadmin.googleapis.com/properties/{property_id}'
        serviceLevel:
          type: string
          description: Required. The service level to set for this property.
          enum:
          - ANALYTICS_SERVICE_LEVEL_UNSPECIFIED
          - ANALYTICS_SERVICE_LEVEL_STANDARD
          - ANALYTICS_SERVICE_LEVEL_360
          x-enum-descriptions:
          - Service level unspecified.
          - The standard version of Google Analytics.
          - The premium version of Google Analytics.
    Empty:
      type: object
      description: 'A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }'
      properties: {}
    AnalyticsAccountLink:
      type: object
      description: A resource message representing the link between a Google Analytics account and a Google Marketing Platform organization.
      properties:
        analyticsAccount:
          type: string
          description: 'Required. Immutable. The resource name of the AnalyticsAdmin API account. The account ID will be used as the ID of this AnalyticsAccountLink resource, which will become the final component of the resource name. Format: analyticsadmin.googleapis.com/accounts/{account_id}'
        name:
          type: string
          description: 'Identifier. Resource name of this AnalyticsAccountLink. Note the resource ID is the same as the ID of the Analtyics account. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} Example: "organizations/xyz/analyticsAccountLinks/1234"'
        displayName:
          type: string
          description: Output only. The human-readable name for the Analytics account.
          readOnly: true
        linkVerificationState:
          type: string
          description: Output only. The verification state of the link between the Analytics account and the parent organization.
          enum:
          - LINK_VERIFICATION_STATE_UNSPECIFIED
          - LINK_VERIFICATION_STATE_VERIFIED
          - LINK_VERIFICATION_STATE_NOT_VERIFIED
          readOnly: true
          x-enum-descriptions:
          - The link state is unknown.
          - The link is established.
          - The link is requested, but hasn't been approved by the product account admin.
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/marketingplatformadmin.analytics.update: Manage your Google Analytics product account data in GMP home
            https://www.googleapis.com/auth/marketingplatformadmin.analytics.read: View your Google Analytics product account data in GMP home
x-generated-from: google-discovery-document
x-source: https://marketingplatformadmin.googleapis.com/$discovery/rest?version=v1alpha
x-discovery-revision: '20261103'