有关儿童地区的资料

方法适用于模式:FBY, FBS, ExpressDBS.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一

返回有关区域的信息,这些区域是请求中指定其ID的区域的子区域。

对于方法 GET v2/regions, GET v2/regions/{regionId}GET v2/regions/{regionId}/children 组资源限制生效。 该限制是对区域总数施加的,使用这些方法请求的信息(不超过100,000个区域)。

白天可以完成的对资源的请求量取决于区域的总数。

⚙️ 限制: 每小时50,000个请求

Request

GET

https://api.partner.market.yandex.ru/v2/regions/{regionId}/children

Path parameters

Name

Description

regionId

Type: integer

区域的ID。

您可以使用请求获取区域ID GET v2/regions.

Query parameters

Name

Description

page

Type: integer

如果方法有 page_token

结果页的编号。

与参数一起使用 pageSize.

page 如果指定,则忽略 page_tokenlimit.

Default: 1

Max value: 10000

pageSize

Type: integer

页面大小。

与参数一起使用 page.

pageSize 如果指定,则忽略 page_tokenlimit.

Responses

200 OK

是请求中指定的区域的子区域。

Body

application/json
{
  "pager": {
    "total": 0,
    "from": 0,
    "to": 0,
    "currentPage": 0,
    "pagesCount": 0,
    "pageSize": 0
  },
  "regions": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null,
    "children": [
      {
        "id": 0,
        "name": "example",
        "type": "OTHER",
        "parent": null
      }
    ]
  }
}

Name

Description

pager

Type: object

currentPage

Type: integer

当前页面。

from

Type: integer

页上找到的元素的初始编号。

pagesCount

Type: integer

的总页数。

pageSize

Type: integer

页面大小。

to

Type: integer

页上找到的元素的最终编号。

total

Type: integer

总共找到了多少件物品。

分页的模型。

Example
{
  "total": 0,
  "from": 0,
  "to": 0,
  "currentPage": 0,
  "pagesCount": 0,
  "pageSize": 0
}

regions

Type: object

All of 2 types
  • Type: object

    id

    Type: integer

    区域的ID。

    name

    Type: string

    区域的名称。

    Example: example

    type

    Type: string

    区域的类型。

    可能的值:

    • CITY_DISTRICT — 城市的面积。

    • CITY — 一个大城市。

    • CONTINENT — 大陆。

    • COUNTRY_DISTRICT — 区域。

    • COUNTRY — 国家。

    • REGION — 地区。

    • REPUBLIC_AREA — 联的主体的区。

    • REPUBLIC — 联的主体。

    • SUBWAY_STATION — 地铁站。

    • VILLAGE — 城市。

    • OTHER — 未知区域。

    Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

    parent

    Type: unknown

    有关父区域的信息。

    父区域指定到国家级别。

    Example: null

    的输送区域。

    Example
    {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "parent": null
    }
    
  • Type: object

    children

    Type: object[]

    id

    Type: integer

    区域的ID。

    name

    Type: string

    区域的名称。

    Example: example

    type

    Type: string

    区域的类型。

    可能的值:

    • CITY_DISTRICT — 城市的面积。

    • CITY — 一个大城市。

    • CONTINENT — 大陆。

    • COUNTRY_DISTRICT — 区域。

    • COUNTRY — 国家。

    • REGION — 地区。

    • REPUBLIC_AREA — 联的主体的区。

    • REPUBLIC — 联的主体。

    • SUBWAY_STATION — 地铁站。

    • VILLAGE — 城市。

    • OTHER — 未知区域。

    Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

    parent

    Type: unknown

    有关父区域的信息。

    父区域指定到国家级别。

    Example: null

    子区域。

    Min items: 1

    Example
    [
      {
        "id": 0,
        "name": "example",
        "type": "OTHER",
        "parent": null
      }
    ]
    
    Example
    {
      "children": [
        {
          "id": 0,
          "name": "example",
          "type": "OTHER",
          "parent": null
        }
      ]
    }
    

有关父区域和子区域的信息。

Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null,
  "children": [
    {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "parent": null
    }
  ]
}

400 Bad Request

请求包含不正确的数据。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

401 Unauthorized

请求中未指定授权数据。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

403 Forbidden

授权数据不正确或禁止访问资源。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

404 Not Found

找不到请求的资源。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

420 Method Failure

已超出资源访问限制。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

500 Internal Server Error

Yandex中的内部错误。 市场。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

No longer supported, please use an alternative and newer version.