Method: projects.locations.agents.flows.versions.compareVersions

Compares the specified base version with target version.

HTTP request

POST https://{endpoint}/v3/{baseVersion=projects/*/locations/*/agents/*/flows/*/versions/*}:compareVersions

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
baseVersion

string

Required. Name of the base flow version to compare with the target version. Use version ID 0 to indicate the draft version of the specified flow.

Format: projects/<Project ID>/locations/<Location ID>/agents/ <Agent ID>/flows/<Flow ID>/versions/<Version ID>.

Authorization requires the following IAM permission on the specified resource baseVersion:

  • dialogflow.versions.get

Request body

The request body contains data with the following structure:

JSON representation 
{
  "targetVersion": string,
  "languageCode": string
}
Fields
targetVersion

string

Required. Name of the target flow version to compare with the base version. Use version ID 0 to indicate the draft version of the specified flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

Authorization requires the following IAM permission on the specified resource targetVersion:

  • dialogflow.versions.get
languageCode

string

The language to compare the flow versions for.

If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Response body

The response message for Versions.CompareVersions.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "baseVersionContentJson": string,
  "targetVersionContentJson": string,
  "compareTime": string
}
Fields
baseVersionContentJson

string

JSON representation of the base version content.
targetVersionContentJson

string

JSON representation of the target version content.
compareTime

string (Timestamp format)

The timestamp when the two version compares.

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".

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.