For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/api/latest/google-chat-integration/update-a-target-audience.md. A documentation index is available at /llms.txt.

Update a target audience

PATCH https://api.ap1.datadoghq.com/api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}https://api.ap2.datadoghq.com/api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}https://api.datadoghq.eu/api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}https://api.ddog-gov.com/api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}https://api.us2.ddog-gov.com/api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}https://api.uk1.datadoghq.com/api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}https://api.datadoghq.com/api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}https://api.us3.datadoghq.com/api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}https://api.us5.datadoghq.com/api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}

Overview

Update a target audience for a Google Chat organization binding in the Datadog Google Chat integration.

Arguments

Path Parameters

Name

Type

Description

organization_binding_id [required]

string

Your organization binding ID.

target_audience_id [required]

string

Your target audience ID.

Request

Body Data (required)

Target audience payload.

Expand All

Field

Type

Description

data [required]

object

Data for an update target audience request.

attributes [required]

object

Attributes for updating a Google Chat target audience.

audience_id

string

The audience ID.

audience_name

string

The audience name.

type [required]

enum

Google Chat target audience resource type. Allowed enum values: google-chat-target-audience

default: google-chat-target-audience

{
  "data": {
    "attributes": {
      "audience_id": "fake-audience-id-1",
      "audience_name": "fake audience name 1"
    },
    "type": "google-chat-target-audience"
  }
}

Response

OK

Response containing a Google Chat target audience.

Expand All

Field

Type

Description

data [required]

object

Google Chat target audience data from a response.

attributes

object

Google Chat target audience attributes.

audience_id [required]

string

The audience ID.

audience_name [required]

string

The audience name.

id

string

The ID of the target audience.

type

enum

Google Chat target audience resource type. Allowed enum values: google-chat-target-audience

default: google-chat-target-audience

{
  "data": {
    "attributes": {
      "audience_id": "fake-audience-id-1",
      "audience_name": "fake audience name 1"
    },
    "id": "1f3e5ce6-944a-4075-97ae-105b5920b5cb",
    "type": "google-chat-target-audience"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export organization_binding_id="CHANGE_ME"
export target_audience_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/integration/google-chat/organizations/${organization_binding_id}/target-audiences/${target_audience_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "audience_id": "updated-audience-id", "audience_name": "updated-audience-name" }, "type": "google-chat-target-audience" } } EOF
"""
Update a target audience returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.google_chat_integration_api import GoogleChatIntegrationApi
from datadog_api_client.v2.model.google_chat_target_audience_type import GoogleChatTargetAudienceType
from datadog_api_client.v2.model.google_chat_target_audience_update_request import GoogleChatTargetAudienceUpdateRequest
from datadog_api_client.v2.model.google_chat_target_audience_update_request_attributes import (
    GoogleChatTargetAudienceUpdateRequestAttributes,
)
from datadog_api_client.v2.model.google_chat_target_audience_update_request_data import (
    GoogleChatTargetAudienceUpdateRequestData,
)

body = GoogleChatTargetAudienceUpdateRequest(
    data=GoogleChatTargetAudienceUpdateRequestData(
        attributes=GoogleChatTargetAudienceUpdateRequestAttributes(
            audience_id="fake-audience-id-1",
            audience_name="fake audience name 1",
        ),
        type=GoogleChatTargetAudienceType.GOOGLE_CHAT_TARGET_AUDIENCE_TYPE,
    ),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = GoogleChatIntegrationApi(api_client)
    response = api_instance.update_google_chat_target_audience(
        organization_binding_id="organization_binding_id", target_audience_id="target_audience_id", body=body
    )

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Update a target audience returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::GoogleChatIntegrationAPI.new

body = DatadogAPIClient::V2::GoogleChatTargetAudienceUpdateRequest.new({
  data: DatadogAPIClient::V2::GoogleChatTargetAudienceUpdateRequestData.new({
    attributes: DatadogAPIClient::V2::GoogleChatTargetAudienceUpdateRequestAttributes.new({
      audience_id: "fake-audience-id-1",
      audience_name: "fake audience name 1",
    }),
    type: DatadogAPIClient::V2::GoogleChatTargetAudienceType::GOOGLE_CHAT_TARGET_AUDIENCE_TYPE,
  }),
})
p api_instance.update_google_chat_target_audience("organization_binding_id", "target_audience_id", body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Update a target audience returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.GoogleChatTargetAudienceUpdateRequest{
		Data: datadogV2.GoogleChatTargetAudienceUpdateRequestData{
			Attributes: datadogV2.GoogleChatTargetAudienceUpdateRequestAttributes{
				AudienceId:   datadog.PtrString("fake-audience-id-1"),
				AudienceName: datadog.PtrString("fake audience name 1"),
			},
			Type: datadogV2.GOOGLECHATTARGETAUDIENCETYPE_GOOGLE_CHAT_TARGET_AUDIENCE_TYPE,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewGoogleChatIntegrationApi(apiClient)
	resp, r, err := api.UpdateGoogleChatTargetAudience(ctx, "organization_binding_id", "target_audience_id", body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GoogleChatIntegrationApi.UpdateGoogleChatTargetAudience`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `GoogleChatIntegrationApi.UpdateGoogleChatTargetAudience`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Update a target audience returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.GoogleChatIntegrationApi;
import com.datadog.api.client.v2.model.GoogleChatTargetAudienceResponse;
import com.datadog.api.client.v2.model.GoogleChatTargetAudienceType;
import com.datadog.api.client.v2.model.GoogleChatTargetAudienceUpdateRequest;
import com.datadog.api.client.v2.model.GoogleChatTargetAudienceUpdateRequestAttributes;
import com.datadog.api.client.v2.model.GoogleChatTargetAudienceUpdateRequestData;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    GoogleChatIntegrationApi apiInstance = new GoogleChatIntegrationApi(defaultClient);

    GoogleChatTargetAudienceUpdateRequest body =
        new GoogleChatTargetAudienceUpdateRequest()
            .data(
                new GoogleChatTargetAudienceUpdateRequestData()
                    .attributes(
                        new GoogleChatTargetAudienceUpdateRequestAttributes()
                            .audienceId("fake-audience-id-1")
                            .audienceName("fake audience name 1"))
                    .type(GoogleChatTargetAudienceType.GOOGLE_CHAT_TARGET_AUDIENCE_TYPE));

    try {
      GoogleChatTargetAudienceResponse result =
          apiInstance.updateGoogleChatTargetAudience(
              "organization_binding_id", "target_audience_id", body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling GoogleChatIntegrationApi#updateGoogleChatTargetAudience");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Update a target audience returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_google_chat_integration::GoogleChatIntegrationAPI;
use datadog_api_client::datadogV2::model::GoogleChatTargetAudienceType;
use datadog_api_client::datadogV2::model::GoogleChatTargetAudienceUpdateRequest;
use datadog_api_client::datadogV2::model::GoogleChatTargetAudienceUpdateRequestAttributes;
use datadog_api_client::datadogV2::model::GoogleChatTargetAudienceUpdateRequestData;

#[tokio::main]
async fn main() {
    let body =
        GoogleChatTargetAudienceUpdateRequest::new(GoogleChatTargetAudienceUpdateRequestData::new(
            GoogleChatTargetAudienceUpdateRequestAttributes::new()
                .audience_id("fake-audience-id-1".to_string())
                .audience_name("fake audience name 1".to_string()),
            GoogleChatTargetAudienceType::GOOGLE_CHAT_TARGET_AUDIENCE_TYPE,
        ));
    let configuration = datadog::Configuration::new();
    let api = GoogleChatIntegrationAPI::with_config(configuration);
    let resp = api
        .update_google_chat_target_audience(
            "organization_binding_id".to_string(),
            "target_audience_id".to_string(),
            body,
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
 * Update a target audience returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v2.GoogleChatIntegrationApi(configuration);

const params: v2.GoogleChatIntegrationApiUpdateGoogleChatTargetAudienceRequest =
  {
    body: {
      data: {
        attributes: {
          audienceId: "fake-audience-id-1",
          audienceName: "fake audience name 1",
        },
        type: "google-chat-target-audience",
      },
    },
    organizationBindingId: "organization_binding_id",
    targetAudienceId: "target_audience_id",
  };

apiInstance
  .updateGoogleChatTargetAudience(params)
  .then((data: v2.GoogleChatTargetAudienceResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"