Dokumentacja dla programistów

Tekst

Aktualizacja 2026-09-06

Kolumna tekstowa przechowuje dowolny tekst. Nie ma stałego limitu znaków, ale łączna pojemność wartości kolumny dla każdego elementu wynosi około 64 KB.

Za pomocą API kolumnę tekstową można odczytywać, filtrować, tworzyć, aktualizować i czyścić.

Typ kolumny Typ implementacji Obsługiwane operacje
text TextValue
  • Odczyt: Tak
  • Filtrowanie: Tak
  • Tworzenie: Tak
  • Aktualizacja: Tak
  • Czyszczenie: Tak

Zapytania

Kolumny tekstowe można odczytywać za pomocą pola column_values obiektu items, używając wbudowanego fragmentu dla TextValue.

query {
  items(ids: [1234567890, 9876543210]) {
    name
    column_values {
      ... on TextValue {
        id
        text
        value
      }
    }
  }
}
const query = `
  query ($itemIds: [ID!]) {
    items(ids: $itemIds) {
      name
      column_values {
        ... on TextValue {
          id
          text
          value
        }
      }
    }
  }
`;

const variables = { itemIds: [1234567890, 9876543210] };

const response = await mondayApiClient.request(query, variables);

Pola

Możesz użyć poniższych pól, aby określić, jakie informacje zwróci implementacja TextValue.

Pole Opis
column Column! Kolumna, do której należy wartość.
id ID! Unikalny identyfikator kolumny.
text String Wartość tekstowa kolumny. Jeśli kolumna jest pusta, zwraca "".
type ColumnType! Typ kolumny (text).
value JSON Surowa wartość kolumny jako ciąg zakodowany w JSON (np. "\"Hello world\"").

Przykładowa odpowiedź

{
  "data": {
    "items": [
      {
        "name": "Task A",
        "column_values": [
          {
            "id": "text",
            "text": "Hello world",
            "value": "\"Hello world\""
          }
        ]
      }
    ]
  }
}

Filtrowanie

Możesz filtrować elementy według wartości tekstowych za pomocą obiektu items_page. Kolumna tekstowa obsługuje następujące operatory:

Operator Porównywana wartość Opis
any_of Tablica dokładnych wartości tekstowych (np. ["Sample text"]) Zwraca elementy, których wartość tekstowa jest dokładnie taka sama jak dowolna z podanych wartości.
not_any_of Tablica dokładnych wartości tekstowych (np. ["Sample text"]) Pomija elementy, których wartość tekstowa jest dokładnie taka sama jak dowolna z podanych wartości.
contains_text Fragment lub pełna wartość tekstowa (np. "hello") Zwraca elementy, których wartość tekstowa zawiera podany ciąg (bez rozróżniania wielkości liter).
not_contains_text Fragment lub pełna wartość tekstowa (np. "hello") Pomija elementy, których wartość tekstowa zawiera podany ciąg.
is_empty [] Zwraca elementy, których wartość tekstowa jest pusta.
is_not_empty [] Zwraca elementy, dla których ustawiono wartość tekstową.

Przykłady

Filtrowanie według częściowego dopasowania tekstu

Ten przykład zwraca elementy, których kolumna tekstowa zawiera „hello”.

query {
  boards(ids: 1234567890) {
    items_page(
      query_params: {
        rules: [
          {
            column_id: "text"
            compare_value: "hello"
            operator: contains_text
          }
        ]
      }
    ) {
      items {
        id
        name
        column_values {
          ... on TextValue {
            text
          }
        }
      }
    }
  }
}

Filtrowanie według dokładnej wartości tekstowej

Ten przykład zwraca elementy z dokładnie pasującą wartością tekstową.

query {
  boards(ids: 1234567890) {
    items_page(
      query_params: {
        rules: [
          {
            column_id: "text"
            compare_value: ["Sample text"]
            operator: any_of
          }
        ]
      }
    ) {
      items {
        id
        name
      }
    }
  }
}

Filtrowanie według pustej wartości tekstowej

Ten przykład zwraca elementy, których wartość tekstowa jest pusta.

query {
  boards(ids: 1234567890) {
    items_page(
      query_params: {
        rules: [
          {
            column_id: "text"
            compare_value: []
            operator: is_empty
          }
        ]
      }
    ) {
      items {
        id
        name
      }
    }
  }
}

Mutacje

Tworzenie

Wymagany zakres uprawnień: boards:write

Mutacja create_column tworzy nową kolumnę tekstową za pomocą API. Możesz określić, które pola mają zostać zwrócone w odpowiedzi mutacji.

mutation {
  create_column(
    board_id: 1234567890
    title: "Notes"
    column_type: text
    description: "Additional notes for this item"
  ) {
    id
    title
    type
  }
}

Aktualizowanie wartości

Możesz zaktualizować kolumnę tekstową za pomocą mutacji change_simple_column_value lub change_multiple_column_values. W zależności od wybranej mutacji możesz przekazać wartość jako zwykły ciąg znaków lub obiekt JSON.

change_simple_column_value

Przekaż wartość jako zwykły ciąg znaków w polu value.

mutation {
  change_simple_column_value(
    item_id: 9876543210
    board_id: 1234567890
    column_id: "text"
    value: "Sample text"
  ) {
    id
    name
  }
}

change_multiple_column_values

Przekaż wartość jako ciąg JSON w polu column_values.

mutation {
  change_multiple_column_values(
    item_id: 9876543210
    board_id: 1234567890
    column_values: "{\"text\": \"Sample text\"}"
  ) {
    id
    name
  }
}
const query = `
  mutation ($boardId: ID!, $itemId: ID!, $columnValues: JSON!) {
    change_multiple_column_values(
      board_id: $boardId
      item_id: $itemId
      column_values: $columnValues
    ) {
      id
      name
    }
  }
`;

const variables = {
  boardId: 1234567890,
  itemId: 9876543210,
  columnValues: JSON.stringify({
    text: "Sample text"
  })
};

const response = await mondayApiClient.request(query, variables);

Ustawianie tekstu podczas tworzenia elementu

Możesz ustawić wartość tekstową podczas tworzenia elementu, przekazując wartość kolumny tekstowej w argumencie column_values.

mutation {
  create_item(
    board_id: 1234567890
    item_name: "New task"
    column_values: "{\"text\": \"Initial notes\"}"
  ) {
    id
    name
  }
}

Czyszczenie

Możesz wyczyścić kolumnę tekstową za pomocą mutacji change_simple_column_value lub change_multiple_column_values.

change_simple_column_value

Przekaż pusty ciąg znaków w polu value.

mutation {
  change_simple_column_value(
    item_id: 9876543210
    board_id: 1234567890
    column_id: "text"
    value: ""
  ) {
    id
    name
  }
}

change_multiple_column_values

Przekaż null lub pusty ciąg znaków w polu column_values.

mutation {
  change_multiple_column_values(
    item_id: 9876543210
    board_id: 1234567890
    column_values: "{\"text\": null}"
  ) {
    id
    name
  }
}

Odczytywanie konfiguracji kolumny

Aby odczytać konfigurację kolumny tekstowej, pobierz jej ustawienia za pomocą pola settings kolumny.

Pole settings_str jest przestarzałe od wersji API 2025-10. Zamiast niego użyj typowanego obiektu settings, który zwraca uporządkowany obiekt JSON, a nie ciąg zakodowany w JSON.

query {
  boards(ids: 1234567890) {
    columns(ids: ["text"]) {
      id
      title
      settings
    }
  }
}

Struktura odpowiedzi settings

Pole settings zwraca typowany obiekt JSON z następującymi kluczami:

Klucz Typ Opis
hide_footer boolean Określa, czy stopka kolumny jest ukryta.

Przykładowa odpowiedź settings

{}

Większość kolumn tekstowych zwraca pusty obiekt ustawień. Opcja hide_footer pojawia się tylko wtedy, gdy została skonfigurowana.


Pobieranie schematu typu kolumny

Możesz programowo pobrać schemat JSON ustawień kolumny tekstowej za pomocą zapytania get_column_type_schema. Zwraca ono strukturę, reguły walidacji i dostępne właściwości konfiguracji kolumny.

query {
  get_column_type_schema(
    type: text
  )
}
{
  "data": {
    "get_column_type_schema": {
      "schema": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "settings": {
            "type": "object",
            "description": "Column specific settings",
            "properties": {
              "hide_footer": {
                "type": "boolean",
                "description": "Whether to hide the footer"
              }
            },
            "additionalProperties": false
          }
        }
      }
    }
  }
}

Odpowiedź zawiera nazwy właściwości, ich typy, ograniczenia (takie jak maksymalna długość i dozwolone wartości) oraz opisy poszczególnych ustawień. Możesz użyć tych informacji do walidacji ustawień kolumn, dynamicznego generowania interfejsów lub przekazywania kontekstu agentom AI. Dowiedz się więcej o formacie odpowiedzi schematu.