# واجهة برمجة تطبيقات العلامات (Tags API)

<Aside type="note">
لتعيين قيم العلامات لـ HWIDs و UserIDs، استخدم أسلوب [/setTags](/ar/developer/api-reference/device-api#settags) من واجهة برمجة تطبيقات الجهاز (Device API).
</Aside>

## addTag

`POST` `https://api.pushwoosh.com/json/1.3/addTag`

تُنشئ علامة في حسابك.

#### نص الطلب

| الاسم | النوع | الوصف |
| ------------------------------------------ | ------- | -------------------------------------------------------------------------------------------------------- |
| auth\* | string | [رمز الوصول لواجهة برمجة التطبيقات (API access token)](/ar/developer/api-reference/api-identifiers/#api-access-token) من لوحة تحكم Pushwoosh. |
| tag\* | object | معلمات العلامة. |
| tag.name\* | string | اسم العلامة. |
| tag.type\* | integer | نوع العلامة. انظر القيم الممكنة أدناه. |
| tag.user\_specific | boolean | عندما تكون القيمة `true`، يتم تخزين قيمة العلامة على مستوى المستخدم ومشاركتها عبر جميع أجهزة المستخدم عند تعيينها بواسطة UserID. عندما تكون القيمة `false` (الافتراضي)، تكون العلامة على مستوى الجهاز ويتم تعيينها لكل HWID. |

<Tabs>
<TabItem label="200">
```json
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "result": true
  }
}
```
</TabItem>
</Tabs>

```json title="مثال"
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // مطلوب. رمز الوصول لواجهة برمجة التطبيقات من لوحة تحكم Pushwoosh
    "tag": {
      "name": "TAG_NAME",           // مطلوب.
      "type": 1,                    // مطلوب. انظر القيم الممكنة أدناه
      "user_specific": false        // اختياري. true = علامة على مستوى المستخدم (مشتركة عبر جميع الأجهزة)؛ false = علامة على مستوى الجهاز (الافتراضي)
    }
  }
}
```

**أنواع قيم العلامات الممكنة:**

* 1 - عدد صحيح
* 2 - سلسلة نصية
* 3 - قائمة
* 4 - تاريخ
* 5 - قيمة منطقية
* 6 - عشري. مثال: 19.95
* 7 - إصدار. مثال: "1.0.0.0"

## deleteTag

`POST` `https://api.pushwoosh.com/json/1.3/deleteTag`

تزيل علامة بالكامل مع جميع المعلومات المرتبطة بها من قاعدة البيانات.

#### نص الطلب

| الاسم | النوع | الوصف |
| ------------------------------------------ | ------ | ---------------------------------------------- |
| auth\* | string | [رمز الوصول لواجهة برمجة التطبيقات (API access token)](/ar/developer/api-reference/api-identifiers/#api-access-token) من لوحة تحكم Pushwoosh. |
| tag\* | object | معلمات العلامة. |
| tag.name\* | string | اسم [العلامة (tag)](/ar/developer/api-reference/api-identifiers/#tag) المراد حذفها. |

<Tabs>
<TabItem label="200">
```json
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "result": true
  }
}
```
</TabItem>
</Tabs>

```json title="مثال"
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // مطلوب. رمز الوصول لواجهة برمجة التطبيقات من لوحة تحكم Pushwoosh
    "tag": {
      "name": "TAG_NAME"            // مطلوب. اسم العلامة المراد حذفها
    }
  }
}


```

## listTags

`POST` `https://api.pushwoosh.com/json/1.3/listTags`

تسترد قائمة بالعلامات الموجودة في الحساب.

#### نص الطلب

| الاسم | النوع | الوصف |
| -------------------------------------- | ------ | ---------------------------------------------- |
| auth\* | string | [رمز الوصول لواجهة برمجة التطبيقات (API access token)](/ar/developer/api-reference/api-identifiers/#api-access-token) من لوحة تحكم Pushwoosh. |

<Tabs>
<TabItem label="200">
```json
{
  "status_code": 200,
  "status_message": "OK", 
  "response": {
    "tags": [{
      "name":"Language",
      "type":2
    }, {
      "name":"List tag",
      "type":3
    }]
  }
}
```
</TabItem>
</Tabs>

```json title="مثال"
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H" // رمز الوصول لواجهة برمجة التطبيقات من لوحة تحكم Pushwoosh
  }
} 
```

**أنواع العلامات**:

* 1 - عدد صحيح
* 2 - سلسلة نصية
* 3 - قائمة
* 4 - تاريخ
* 5 - قيمة منطقية
* 6 - عشري. مثال: 19.95
* 7 - إصدار. مثال: "1.0.0.0"