O RBM cria arquivos de dados que informam a atividade do usuário e do agente nos níveis de resumo e transacional. Os dados são separados em vários arquivos:
| Arquivo | Descrição | Quem pode acessar |
|---|---|---|
| Relatório de eventos de faturamento | Um registro de eventos faturáveis entre agentes e usuários lançados | Todas as operadoras com tráfego RBM nas próprias redes |
| Registro de atividades | Dados brutos de atividade da plataforma RBM | Operadoras que têm tráfego RBM nas próprias redes e ativam a atividade RCS com o Jibe Cloud de acordo com os próprios Termos de Serviço (ToS) |
Geração
Os relatórios de eventos de faturamento e os Registros de atividades têm um atraso de dois dias na geração.
O Google só informa um evento de atividade quando a sessão de faturamento a que ele pertence é concluída. Uma sessão pode levar até 24 horas para ser concluída. O pipeline de faturamento é executado uma vez por dia e só informa as sessões de faturamento que foram concluídas há pelo menos 24 horas.
Exemplo:
Uma mensagem é enviada no dia d e inicia uma sessão de faturamento, mas perdeu a execução do pipeline uma hora antes. Portanto, nenhum evento de atividade é informado.
Quando o pipeline é executado novamente em d+1, a sessão iniciada pela mensagem tem apenas 23 horas. Portanto, nenhum evento de atividade para essa mensagem é informado em d+1.
Quando o pipeline é executado novamente em d+2, a sessão foi concluída para que o evento de atividade seja informado com a sessão de faturamento.
Armazenamento e acesso
Os arquivos de dados são criptografados em repouso e em transferência.
Para recuperar arquivos de dados por SFTP, você precisa fornecer sua chave pública SFTP. Para gerar chaves, consulte Gerar um par de chaves Secure Shell (SSH) para uma caixa de depósito SFTP.
O servidor SFTP é partnerupload.google.com e a conexão está em um número de porta alto (19321) para maior segurança.
Use o seguinte comando para acessar seus arquivos de dados:
sftp -i <path_to_private_key> -P 19321 <username>@partnerupload.google.com
O Google fornece nomes de usuário de contas nos seguintes formatos:
rbmreports-billableevents-<carrier name>rbmreports-activity-<carrier name>
O Google especifica o campo <carrier name> e fornece uma conta separada para cada tipo de relatório.
Contas separadas são fornecidas para acessar os diferentes tipos de relatórios.
Disponibilidade do arquivo
Se nenhum arquivo de relatório tiver sido gerado ainda, você verá um erro SFTP semelhante a remote readdir("/"): No such file or directory. Isso já era esperado.
Se não houver tráfego do RBM a ser informado, um arquivo não será gerado. Isso significa que pode haver alguns dias em que os arquivos não são gerados. Entre em contato com rbm-support@google.com se precisar que arquivos vazios sejam gerados nessa situação para simplificar o processamento.
Atualização e retenção
Cada arquivo de dados representa um dia de uso da plataforma no horário UTC. Os registros de um determinado dia são gerados uma vez e finalizados em até dois dias (48 horas) após o término do dia. Se você carregar esses arquivos em um data warehouse, poderá atualizar as métricas do mês atual.
Um arquivo não é gerado se não houver atividade a ser considerada.
A data no nome de cada arquivo é a data em que o arquivo foi gerado. Os registros no arquivo abrangem o dia UTC que vem dois dias antes da data do arquivo.
O processo de exportação que gera os arquivos é executado entre 14h e 4h (horário de Brasília).
Os arquivos de dados são retidos por no máximo 30 dias antes de serem excluídos.
Relatórios de eventos de faturamento
Os relatórios de eventos de faturamento são registros de eventos faturáveis calculados a partir de mensagens subjacentes usando as unidades de faturamento sugeridas. Os eventos faturáveis contêm informações confidenciais, mas nenhuma PII do usuário (por exemplo, nenhum MSISDN, MSISDN com hash ou qualquer identificador único de usuário).
Somente agentes iniciados geram eventos de faturamento. As atividades dos agentes que ainda não foram lançados ou que ainda não foram lançados não aparecem nos relatórios de faturamento.
Os relatórios de faturamento presumem que os eventos são cobrados na entrega das mensagens, e não quando elas são enviadas. Uma mensagem não entregue ou revogada antes da entrega não aciona um evento de faturamento.
Cada agente do RBM tem uma categoria de faturamento, definida pelo desenvolvedor do agente antes de enviá-lo para o lançamento. A categoria de faturamento determina se as mensagens enviadas pelo agente são discretas ou se podem ser combinadas em eventos de faturamento de conversa.
Há cinco tipos de eventos faturáveis:
| Evento | Definição |
|---|---|
| Mensagem básica | Uma mensagem de aplicativo para pessoa (A2P) que
Somente agentes de conversa: se uma mensagem P2A for entregue como resposta a uma mensagem A2P nas próximas 24 horas, a mensagem básica se tornará parte de uma conversa A2P. Caso contrário, a sessão será encerrada. Uma Mensagem básica sempre é enviada de um agente para um usuário. |
| Mensagem única | Uma mensagem de aplicativo para pessoa (A2P) que
Somente agentes de conversa: se uma mensagem P2A for entregue nas próximas 24 horas, a mensagem única se tornará parte de uma conversa A2P. Caso contrário, a sessão será encerrada. Uma mensagem única é sempre entregue de um agente para um usuário. |
| Conversa A2P | Aplicável apenas a agentes de conversação: uma conversa A2P é iniciada quando uma mensagem P2A é entregue dentro de 24 horas depois de uma mensagem única ou mensagem básica A2P. Se uma mensagem P2A for entregue em até 24 horas após várias mensagens A2P, apenas a mensagem A2P que precedeu imediatamente a mensagem P2A será usada para criar a sessão de conversa. Esta mensagem A2P e todas as mensagens entregues nas próximas 24 horas fazem parte da nova conversa A2P. |
| Conversa P2A | Aplicável apenas a agentes de conversação: uma conversa P2A é iniciada quando não há uma sessão ativa (mensagem única, conversa A2P ou conversa P2A) e uma mensagem P2A é entregue e a empresa responde em até 24 horas. |
| Mensagem P2A | Agentes que não são de conversa: uma mensagem P2A enviada de um usuário para
um agente com uma categoria de faturamento
de mensagem única ou mensagem básica.
Agentes de conversa: uma mensagem P2A enviada de um usuário para um agente em que não existe uma conversa e o agente não retorna uma resposta. |
Disponibilidade
Os relatórios de eventos de faturamento estão disponíveis para todas as operadoras que têm tráfego do RBM nas respectivas redes.
Formato
Os relatórios de eventos de faturamento usam o formato de nome de arquivo YYYY/MM/DD/rbm_billable_events_YYYY-MM-DD.csv.
A data no nome do arquivo é a data em que o arquivo foi gerado. Os registros no arquivo geralmente abrangem a atividade do dia dois dias antes dessa data.
Os campos em um registro são separados por tabulação e há um registro por linha.
Haverá um registro para cada evento de faturamento, ou seja, duas conversas A2P com o mesmo agente vão gerar dois eventos de faturamento e dois registros no relatório.
Cada registro no relatório de eventos faturáveis contém as seguintes informações para cada evento:
| Campo | Formato | Descrição | Exemplo |
|---|---|---|---|
billing_event_id
|
string | O identificador UUID, um número aleatório, gerado para cada novo evento no momento em que é criado. | |
type
|
string | É o tipo de evento:
|
single_message
|
agent_id
|
string | O identificador do agente que participou do evento. | rbm-welcome-bot@rbm.goog
|
agent_owner
|
string | O e-mail do proprietário do agente que participou do evento. Essa é a parte que registrou o agente do RBM. Na maioria dos casos, o agregador, mas em alguns casos raros, pode ser a marca. Esse valor é extraído do campo "Conta do Google do RBM", fornecido quando o desenvolvedor se registrou para usar o RBM. | name@aggregator.com
|
billing_party
|
string | A festa que cobra por eventos.
|
carrier
|
max_duration_single_message
|
number | Duração, em horas, da mensagem de um agente sem receber uma resposta para identificar uma única sessão de mensagem. | 24
|
max_duration_a2p_conversation
|
number | A duração máxima de uma sessão A2P, em horas. Medido desde a primeira resposta do usuário à mensagem inicial do agente. | 24
|
max_duration_p2a_conversation
|
number | A duração máxima de uma sessão P2A, em horas. Medido a partir da primeira mensagem do usuário na conversa. | 24
|
start_time
|
YYYY-mm-ddTHH:00:00Z | A data/hora UTC em que o evento começou, no formato ISO 8601, arredondada para a hora mais próxima.
|
2019-07-25T08:00:00Z
|
duration
|
number | A duração do evento, arredondada para o minuto mais próximo.
Quando o tipo de evento é |
45
|
mt_messages
|
number | O número de mensagens encerradas em dispositivos móveis no evento. | 11
|
mo_messages
|
number | O número de mensagens originadas de dispositivos móveis no evento. | 9
|
size_kilobytes
|
number | O tamanho de todos os arquivos anexados às mensagens no evento, arredondados para o kilobyte mais próximo (1 KB = 1.024 bytes). | 912
|
agent_name
|
string |
O agente que participou do evento. |
XYZ Mobile USA
|
owner_name
|
string | O proprietário do agente que participou do evento. É a parte que registrou o agente do RBM. Na maioria dos casos, é o agregador, mas em alguns casos raros pode ser a marca. Esse valor é retirado do "Nome de exibição preferencial da sua conta do parceiro" fornecido quando o desenvolvedor se registrou para usar o RBM. | XYZ Mobile
|
Arquivo de amostra
Um exemplo de arquivo de relatório de faturamento está disponível para download.
Tamanho de arquivo típico
Um arquivo de relatório diário de um parceiro ativo pode ter cerca de 53.000 registros e aproximadamente 8 MB.
Registros de atividade
Os registros de atividades são dados brutos de atividades na plataforma RBM para auditar eventos faturáveis e criar eventos personalizados.
Disponibilidade
Os registros de atividades estão disponíveis apenas para operadoras que têm tráfego RBM nas redes e ativam a atividade RCS com o Jibe Cloud de acordo com os próprios Termos de Serviço (ToS). Se você usar o Jibe Cloud nos Termos de Serviço da Jibe, não terá acesso aos registros de atividades.
Formato
Os registros de atividades usam o formato de nome de arquivo YYYY/MM/DD/rbm_activity_YYYY-MM-DD.csv.
A data no nome do arquivo é a data em que o arquivo foi gerado. Os registros no arquivo geralmente abrangem a atividade do dia dois dias antes dessa data.
Os campos em um registro são separados por tabulação e há um registro por linha.
Cada registro no registro de atividades contém os campos a seguir para cada evento de atividade.
| Campo | Formato | Descrição | Exemplo |
|---|---|---|---|
activity_id
|
string | Identificador da atividade. | |
billing_event_id
|
string | Identificador do evento de faturamento em que a atividade ocorreu. Pode ficar vazio se a atividade não estiver associada a nenhuma sessão, como uma text_message sem um delivery_receipt_event correspondente.
| |
agent_id
|
string | O identificador do agente. | welcome-bot@rbm.goog
|
user_id
|
string | O MSISDN do usuário. | 918369110173
|
direction
|
string | A direção em que a mensagem foi enviada:
|
MT
|
time
|
YYYY-mm-ddTHH:MM:SS.SSSZ | A data/hora UTC em que o evento foi enviado à plataforma RBM. Confira a observação abaixo. | 2019-07-25T00:29:07.033Z
|
type
|
string | O tipo de atividade:
|
text_message
|
size_bytes
|
string | O tamanho dos arquivos anexados à atividade em bytes. | 912
|
Uma observação sobre marcações de tempo
Os carimbos de data/hora nos registros de atividades registram a hora em que um evento foi enviado à plataforma RBM. No caso de eventos que enviam conteúdo a um usuário, eles não serão gravados no Registro de atividades até que a mensagem tenha sido entregue.
Por exemplo, se uma mensagem do RBM for enviada a um usuário na quarta-feira às 13h e o destinatário ficar off-line até domingo às 9h, o evento vai aparecer no Registro de atividades gerado para domingo. O carimbo de data/hora do evento no Registro de atividades será quarta-feira, às 13h.