API de Tags

Nota

Para definir valores de tag para HWIDs e UserIDs, use o método /setTags da API de Dispositivo.

addTag

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

Cria uma tag em sua conta.

Corpo da solicitação

Nome	Tipo	Descrição
auth*	string	Token de acesso à API do Painel de Controle Pushwoosh.
tag*	object	Parâmetros da tag.
tag.name*	string	Nome da tag.
tag.type*	integer	Tipo de tag. Veja os valores possíveis abaixo.
tag.user_specific	boolean	Quando true, o valor da tag é armazenado no nível do usuário e compartilhado entre todos os dispositivos de um usuário quando definido por UserID. Quando false (padrão), a tag é no nível do dispositivo e definida por HWID.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "result": true
  }
}

Exemplo

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
    "tag": {
      "name": "TAG_NAME",           // obrigatório.
      "type": 1,                    // obrigatório. Veja os valores possíveis abaixo
      "user_specific": false        // opcional. true = tag de nível de usuário (compartilhada entre todos os dispositivos); false = tag de nível de dispositivo (padrão)
    }
  }
}

Tipos de valor de tag possíveis:

• 1 - Integer
• 2 - String
• 3 - List
• 4 - Date
• 5 - Boolean
• 6 - Decimal. Ex: 19.95
• 7 - Version. Ex: “1.0.0.0”

deleteTag

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

Remove completamente uma tag com todas as informações associadas do banco de dados.

Corpo da solicitação

Nome	Tipo	Descrição
auth*	string	Token de acesso à API do Painel de Controle Pushwoosh.
tag*	object	Parâmetros da tag.
tag.name*	string	Nome de uma tag para excluir.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "result": true
  }
}

Exemplo

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
    "tag": {
      "name": "TAG_NAME"            // obrigatório. Nome de uma tag para excluir
    }
  }
}

listTags

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

Recupera uma lista de tags na conta.

Corpo da solicitação

Nome	Tipo	Descrição
auth*	string	Token de acesso à API do Painel de Controle Pushwoosh.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "tags": [{
      "name":"Language",
      "type":2
    }, {
      "name":"List tag",
      "type":3
    }]
  }
}

Exemplo

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H" // Token de acesso à API do Painel de Controle Pushwoosh
  }
}

Tipos de tag:

• 1 - Integer
• 2 - String
• 3 - List
• 4 - Date
• 5 - Boolean
• 6 - Decimal. Ex: 19.95
• 7 - Version. Ex: “1.0.0.0”