> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# セルの結合

> 本 API を呼び出すことで、スプレッドシート内の指定範囲にある複数のセルを 1 つに結合できます。結合後は左上のセルのデータのみが保持され、その他のセルの内容はクリアされます。レスポンスでは実際に操作されたセルのアドレスが返されます。

本 API を呼び出すことで、DingTalk スプレッドシート内の指定範囲にある複数のセルを 1 つに結合できます。表のヘッダーで列をまたぐ見出しを作成したり、同じ分類の行を結合したりするなど、セルレイアウトを調整するシーンに適しています。すべて結合・行単位で結合・列単位で結合の 3 種類のモードに対応しており、結合後は左上のセルのデータのみが保持され、その他のセルの内容はクリアされます。レスポンスでは実際に操作されたセルのアドレスが返されます。

## リクエスト

### 基本情報

| フィールド       | 値                                                                                                      |
| ----------- | ------------------------------------------------------------------------------------------------------ |
| HTTP URL    | `https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress}/merge` |
| HTTP Method | POST                                                                                                   |
| 対応するアプリタイプ  | appType-社内アプリ                                                                                          |
| 必要な権限       | permission-Document.Workbook.Write-DingTalk スプレッドシートの書き込み権限                                            |

### リクエストヘッダー

| 名前                          | タイプ    | 必須 | 説明                                                                                                                                     |
| --------------------------- | ------ | -- | -------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | はい | 本 API を呼び出すためのアクセス認証情報。[社内アプリの access\_token を取得する](/ja/open/development/obtain-the-access-token-of-an-internal-app) API を呼び出して取得できます。 |

### パスパラメータ

| 名前           | タイプ    | 必須 | 説明                                                                                                                                                                                                                                                                                              |
| ------------ | ------ | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| workbookId   | String | はい | スプレッドシートファイルの ID。[ナレッジベース API](/ja/open/development/knowledge-base-overview) から返される nodeId（dentryUuid）がスプレッドシートの workbookId です。[ノードを取得する](/ja/open/development/get-knowledge-base-acquisition-node) および [ナレッジベースドキュメントを作成する](/ja/open/development/create-team-space-document) API を呼び出して取得できます。 |
| sheetId      | String | はい | ワークシートの ID またはタイトル。[すべてのワークシートを取得する](/ja/open/development/obtain-all-worksheets) API を呼び出して id およびワークシートのタイトルを取得できます。                                                                                                                                                                           |
| rangeAddress | String | はい | 結合対象のセル範囲。フォーマットは `範囲内の左上のセル:範囲内の右下のセル` です。例：B2:C3                                                                                                                                                                                                                                              |

### クエリパラメータ

| 名前         | タイプ    | 必須 | 説明                                                                                                                                                   |
| ---------- | ------ | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| operatorId | String | はい | 操作者の unionId。[ユーザー詳細を照会する](/ja/open/development/query-user-details) API を呼び出して取得できます。操作者に権限がない場合、API は `The operator has no permission` というエラーを返します。 |

### リクエストボディ

| 名前        | タイプ    | 必須  | 説明                                                                                                                                                                              |
| --------- | ------ | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| mergeType | String | いいえ | セルの結合方法を指定します。指定可能な値：   - **mergeAll**：すべてのセルを結合します（デフォルト） - **mergeRows**：行単位で結合します。選択範囲内で同じ行の隣接するセルを 1 つのセルに結合します - **mergeColumns**：列単位で結合します。選択範囲内で同じ列の隣接するセルを 1 つのセルに結合します |

### リクエスト例

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/ranges/A1:B1/merge?operatorId=ppgAQuxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:token:f86e0bxxx
Content-Type:application/json

{
  "mergeType" : "mergeRows"
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Token を使用してアカウント Client を初期化します</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkdoc_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.MergeRangeHeaders mergeRangeHeaders = new com.aliyun.dingtalkdoc_1_0.models.MergeRangeHeaders();
        mergeRangeHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.MergeRangeRequest mergeRangeRequest = new com.aliyun.dingtalkdoc_1_0.models.MergeRangeRequest()
                .setOperatorId("ppgAQuxxx")
                .setMergeType("mergeRows");
        try {
            client.mergeRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", mergeRangeRequest, mergeRangeHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_dingtalk.doc_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkdoc_1_0Client:
        """
        Token を使用してアカウント Client を初期化します
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdoc_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        merge_range_headers = dingtalkdoc__1__0_models.MergeRangeHeaders()
        merge_range_headers.x_acs_dingtalk_access_token = '<your access token>'
        merge_range_request = dingtalkdoc__1__0_models.MergeRangeRequest(
            operator_id='ppgAQuxxx',
            merge_type='mergeRows'
        )
        try:
            client.merge_range_with_options('e54Lq3xxx', 'Sheet1', 'A1:B1', merge_range_request, merge_range_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれており、開発時の問題特定に役立ちます
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        merge_range_headers = dingtalkdoc__1__0_models.MergeRangeHeaders()
        merge_range_headers.x_acs_dingtalk_access_token = '<your access token>'
        merge_range_request = dingtalkdoc__1__0_models.MergeRangeRequest(
            operator_id='ppgAQuxxx',
            merge_type='mergeRows'
        )
        try:
            await client.merge_range_with_options_async('e54Lq3xxx', 'Sheet1', 'A1:B1', merge_range_request, merge_range_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれており、開発時の問題特定に役立ちます
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\MergeRangeHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\MergeRangeRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Token を使用してアカウント Client を初期化します
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $mergeRangeHeaders = new MergeRangeHeaders([]);
        $mergeRangeHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $mergeRangeRequest = new MergeRangeRequest([
            "operatorId" => "ppgAQuxxx",
            "mergeType" => "mergeRows"
        ]);
        try {
            $client->mergeRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", $mergeRangeRequest, $mergeRangeHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_1_0  "github.com/alibabacloud-go/dingtalk/doc_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Token を使用してアカウント Client を初期化します
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkdoc_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdoc_1_0.Client{}
  _result, _err = dingtalkdoc_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  mergeRangeHeaders := &dingtalkdoc_1_0.MergeRangeHeaders{}
  mergeRangeHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  mergeRangeRequest := &dingtalkdoc_1_0.MergeRangeRequest{
    OperatorId: tea.String("ppgAQuxxx"),
    MergeType: tea.String("mergeRows"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.MergeRangeWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("A1:B1"), mergeRangeRequest, mergeRangeHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
```

Node.js

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkdoc_1_0 = require('@alicloud/dingtalk/doc_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Token を使用してアカウント Client を初期化します
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkdoc_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let mergeRangeHeaders = new dingtalkdoc_1_0.MergeRangeHeaders({ });
    mergeRangeHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let mergeRangeRequest = new dingtalkdoc_1_0.MergeRangeRequest({
      operatorId: 'ppgAQuxxx',
      mergeType: 'mergeRows',
    });
    try {
      await client.mergeRangeWithOptions('e54Lq3xxx', 'Sheet1', 'A1:B1', mergeRangeRequest, mergeRangeHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
using Newtonsoft.Json;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Token を使用してアカウント Client を初期化します</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkdoc_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.MergeRangeHeaders mergeRangeHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.MergeRangeHeaders();
            mergeRangeHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.MergeRangeRequest mergeRangeRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.MergeRangeRequest
            {
                OperatorId = "ppgAQuxxx",
                MergeType = "mergeRows",
            };
            try
            {
                client.MergeRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", mergeRangeRequest, mergeRangeHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}
```

## レスポンス

### レスポンスボディ

| 名前         | タイプ    | 説明                                                 |
| ---------- | ------ | -------------------------------------------------- |
| a1Notation | String | 結合されたセル範囲。フォーマットは `範囲内の左上のセル:範囲内の右下のセル` です。例：B2:C3 |

### レスポンスボディの例

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "a1Notation" : "A1:B1"
}
```

### エラーコード

本 API の呼び出し時にエラーが発生した場合は、エラーメッセージをもとに [グローバルエラーコード](/ja/open/development/server-api-error-codes-1) ドキュメントで解決方法を検索してください。

| HttpCode | エラーコード                                     | エラーメッセージ                                                                                                                                            | 説明                                      |
| -------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| 400      | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal.                                                                                                                          | workbookId が不正です。                       |
| 400      | invalidRequest.inputArgs.unionIdIllegal    | The operatorId is illegal.                                                                                                                          | operatorId が不正です。                       |
| 400      | invalidRequest.inputArgs.invalid           | %s                                                                                                                                                  | リクエストパラメータが不正です。エラーメッセージを確認してください。      |
| 403      | forbidden.operationIllegal                 | %s                                                                                                                                                  | リクエスト操作が不正です。エラーメッセージを確認してください。         |
| 403      | forbidden.accessDenied                     | The operator has no permission.                                                                                                                     | 現在のユーザーには本操作の権限がありません。                  |
| 403      | forbidden.document.sizeOverLimit           | The document size is over limit and the server is unable to complete your request. Retry is unlikely to work unless the document size is decreased. | スプレッドシートのコンテンツが大きすぎます。コンテンツの縮減をお試しください。 |
| 404      | invalidRequest.resource.notFound           | %s                                                                                                                                                  | リクエストに失敗しました。アクセス対象のリソースが見つかりません。       |
| 500      | internalError                              | The server encountered an internal error and was unable to complete your request. Please try again later.                                           | サーバー内部エラーが発生しました。後で再試行してください。           |
| 503      | serviceBusy                                | The server is busy and unable to complete your request. Please try again later.                                                                     | サービスが混雑しています。後で再試行してください。               |