Esta página descreve os arquivos de dados que o RCS for Business cria para auxiliar as operadoras com faturamento e auditoria.
| Arquivo | Descrição | Quem tem acesso? |
|---|---|---|
| Relatório de faturamento | Relatório agregado de eventos faturáveis entre agentes e usuários iniciados. | Todas as operadoras que estão operando ativamente o RCS para Empresas. |
| Registro de atividades | Registro de dados brutos do RCS para atividades comerciais, incluindo eventos faturáveis. | Operadoras que estão ativamente utilizando o RCS para Empresas e que operam o Serviço RCS do Google sob seus próprios Termos de Serviço (ToS). |
O RCS for Business utiliza um modelo de faturamento padrão para tráfego fora dos EUA. Para obter detalhes, consulte as Perguntas Frequentes sobre Faturamento .
Geração de arquivos
Cada arquivo de dados representa um dia de uso do RCS for Business no Horário Padrão do Pacífico (PST). Os arquivos são gerados diariamente e refletem a atividade das últimas 24 horas (da meia-noite à meia-noite). O processo de geração pode levar várias horas e o tempo de conclusão pode variar.
- Para agentes não conversacionais , os arquivos contêm dados do período de 24 horas imediatamente anterior ao dia em que o arquivo foi gerado. Por exemplo, um relatório gerado em 5 de maio abrange dados das 00h00 do dia 4 de maio às 00h00 do dia 5 de maio. O horário especificado está no fuso horário PST.
Para agentes conversacionais , os arquivos contêm dados do período de 24 horas, de 1 a 2 dias antes do horário de geração do arquivo. Por exemplo, um relatório gerado em 5 de maio abrange dados do período de 24 horas entre 2 e 3 de maio. O horário especificado está no fuso horário PST.
O atraso se deve ao fato de que a atividade do RCS for Business para agentes conversacionais está vinculada a sessões, que podem levar até 24 horas para serem concluídas. Esse atraso permite que o RCS for Business capture todas as mensagens de uma conversa antes de calcular o evento faturável. Para obter mais informações sobre agentes conversacionais, consulte Categorias de faturamento de agentes .
Pontos principais:
- Sem atividade : Por padrão, nenhum arquivo é gerado se não houver atividade na plataforma em um determinado dia. No entanto, você pode optar por receber arquivos vazios, se necessário. Para optar por essa opção, entre em contato com rbm-support@google.com.
- Nomeação : A data no nome do arquivo é a data de geração do arquivo, não a data dos dados contidos nele.
- Retenção : Os arquivos são armazenados por um período máximo de 63 dias antes de serem excluídos.
Você pode usar esses arquivos para atualizar seu data warehouse com as métricas de uso mais recentes da plataforma.
Armazenamento e acesso a arquivos
Os arquivos de dados são criptografados em repouso e durante a transferência.
Para recuperar arquivos de dados por meio do Protocolo de Transferência de Arquivos Seguro (SFTP), forneça sua chave pública SFTP. Para gerar chaves, consulte Gerar um par de chaves Secure Shell (SSH) para um Dropbox SFTP .
O servidor SFTP é partnerupload.google.com e a conexão é feita em uma porta alta (19321) para maior segurança.
Você pode usar 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 <carrier name> e fornece uma conta separada para cada tipo de relatório.
São fornecidas contas separadas para acessar os diferentes tipos de relatório.
Disponibilidade de arquivos
Se nenhum arquivo de dados tiver sido gerado ainda, você verá um erro SFTP semelhante a remote readdir("/"): No such file or directory , o que é esperado.
Nenhum arquivo será gerado se não houver tráfego RCS for Business para relatar. Isso significa que pode haver dias em que nenhum arquivo seja gerado. Se você precisar de arquivos vazios para agilizar seu processo, entre em contato com a equipe de suporte do RCS for Business .
Relatórios de faturamento
Os relatórios de faturamento são registros de eventos faturáveis , calculados com base na categoria de faturamento do agente e no tipo de mensagens enviadas. Os relatórios de faturamento estão disponíveis para todas as operadoras que utilizam o RCS for Business.
Os relatórios de faturamento contêm informações confidenciais, mas não incluem informações de identificação pessoal (PII) do usuário, como MSISDN, MSISDN criptografado ou qualquer identificador exclusivo do usuário.
Categorias de faturamento do agente
Ao criar um agente, o proprietário define sua categoria de faturamento com base em como o agente interagirá com os usuários. A categoria de faturamento não restringe o número ou o tipo de mensagens que um agente pode enviar. No entanto, ela determina como o agente será cobrado pelas mensagens. As duas principais categorias de faturamento são descritas na tabela a seguir.
| Categoria de faturamento | Tipo de agente | Exemplos de casos de uso | Método de faturamento |
|---|---|---|---|
| Não conversacional | Agentes que enviam principalmente mensagens unidirecionais. |
| Cobrança por cada mensagem entregue ao usuário. |
| Conversacional | Agentes projetados para trocas bilaterais com usuários. |
| Cobrança por conversa : Se uma das partes (o agente ou o usuário) responder a uma mensagem da outra parte em até 24 horas, uma conversa é iniciada. Durante o período da conversa (24 horas após a primeira resposta), o agente e o usuário podem trocar quantas mensagens desejarem, e o agente será cobrado uma taxa fixa por conversa. Cobrança por mensagem : Se o agente entregar uma mensagem à qual o usuário não responder em 24 horas, o agente será cobrado pela mensagem individual, de forma semelhante a um agente não conversacional. |
O diagrama a seguir mostra um exemplo de uma sessão de faturamento A2P para agentes conversacionais:
Agentes conversacionais versus agentes não conversacionais
Existem duas categorias principais de cobrança: conversacional e não conversacional.
A principal diferença nas categorias de faturamento reside entre agentes conversacionais e não conversacionais:
Os agentes não conversacionais são cobrados por cada mensagem que entregam ao usuário.
- Esta categoria é ideal para agentes que não esperam respostas frequentes.
Os agentes de conversação são cobrados por conversação , o que inclui todas as mensagens trocadas em um período de 24 horas.
- Esta categoria é ideal para agentes que participam de conversas com vários usuários, que envolvem diversas interações.
Eventos faturáveis
Cinco tipos de eventos faturáveis são registrados nos relatórios de faturamento. Esses eventos incluem eventos MT e MO, que são denominados eventos A2P e P2A.
- A2P (Application-to-Person) é MT (Mobile Terminated) : uma mensagem enviada pela empresa.
- P2A (Pessoa para Aplicativo) é MO (Originado por Dispositivo Móvel) : Uma mensagem ou ação iniciada pelo usuário.
A tabela a seguir descreve cada evento faturável, tanto para agentes não conversacionais quanto para agentes conversacionais.
| Evento | Descrição | Agentes não conversacionais | Agentes conversacionais |
|---|---|---|---|
basic_message | Mensagem A2P que inclui apenas texto com 160 caracteres ou menos. Se o texto incluir um URL para um site com tags OpenGraph , a mensagem poderá exibir uma pré-visualização da imagem, sem custo adicional para o parceiro. | Sempre tratado como um evento faturável individual, independentemente de o usuário responder ou não. | Tratada como um evento faturável individual, a menos que o usuário responda em até 24 horas. Nesse caso, a mensagem passa a fazer parte de uma a2p_conversation . |
single_message | Mensagem A2P que contém conteúdo rico ou é uma mensagem somente de texto com mais de 160 caracteres. | Sempre tratado como um evento faturável individual, independentemente de o usuário responder ou não. | Tratada como um evento faturável individual, a menos que o usuário responda em até 24 horas. Nesse caso, a mensagem passa a fazer parte de uma a2p_conversation . |
a2p_conversation (iniciada pela empresa) | Iniciada quando um usuário responde a uma mensagem A2P dentro de 24 horas após recebê-la, fora de uma conversa existente. | Não aplicável. Agentes não conversacionais nunca geram esse tipo de evento. | Se uma mensagem P2A for entregue dentro de 24 horas após múltiplas mensagens A2P, apenas a mensagem A2P que precedeu imediatamente a mensagem P2A será usada para iniciar a conversa. Essa mensagem A2P, e quaisquer mensagens entregues nas próximas 24 horas, fazem parte da a2p_conversation . |
p2a_conversation (iniciada pelo usuário) | Iniciada quando um agente responde a uma mensagem P2A dentro de 24 horas após recebê-la, fora de uma conversa existente. | Não aplicável. Agentes não conversacionais nunca geram esse tipo de evento. | Se uma mensagem A2P for entregue dentro de 24 horas após várias mensagens P2A, apenas a mensagem P2A que precedeu imediatamente a mensagem A2P será usada para iniciar a conversa. Essa mensagem P2A, e quaisquer mensagens entregues nas próximas 24 horas, fazem parte da p2a_conversation . |
p2a_message | Mensagem P2A de qualquer tipo. | Sempre tratado como um evento faturável individual, independentemente de o agente responder ou não. | Será tratado como um evento faturável individual, a menos que o agente responda dentro de 24 horas. |
Categorias de faturamento versus eventos faturáveis
A distinção entre categorias de faturamento de agentes e eventos faturáveis é fundamental para entender como seu agente é cobrado.
- A categoria de faturamento é uma classificação fixa que você escolhe ao criar seu agente. Ela determina o método de cobrança do seu agente: por mensagem (agentes não conversacionais) ou por conversa (agentes conversacionais).
- Eventos faturáveis são interações entre um agente RCS for Business e um usuário que são rastreadas para fins de faturamento (por exemplo,
basic_message,single_message,a2p_conversation).
Geração de relatórios de faturamento
Somente os agentes com tráfego que não seja de teste geram eventos faturáveis. A atividade de números de telefone de teste não aparece nos relatórios de faturamento.
Esses relatórios partem do princípio de que os eventos são cobrados quando as mensagens são entregues, e não quando são enviadas. Uma mensagem não entregue ou cancelada antes da entrega não gera um evento faturável.
Formato do relatório de faturamento
Os relatórios de faturamento utilizam o formato de nome de arquivo rbm_billable_events_YYYY-MM-DD.csv . A data no nome do arquivo é a data de geração do arquivo.
Cada linha no relatório representa um registro de um único evento faturável. Os campos dentro de um registro são separados por tabulação. Por exemplo, duas conversas A2P com o mesmo agente gerariam dois eventos faturáveis separados e dois registros no relatório de faturamento.
Cada registro no relatório contém as seguintes informações para cada evento faturável.
| Campo | Formatar | Descrição | Exemplo |
|---|---|---|---|
billing_event_id | corda | ID gerado que distingue o evento faturável. | 242f1d9f-7c3f-4e5b-ab3f-818f188fa3ff |
type | corda | Tipo de evento:
| single_message |
agent_id | corda | Identificador único do agente que participou do evento. | rbm-welcome-bot@rbm.goog |
agent_owner | corda | Endereço de e-mail do proprietário atual da conta de parceiro onde o agente foi criado. | name@aggregator.com |
billing_party | corda | Parte que cobra pelos eventos.
| carrier |
max_duration_single_message | número | Tempo máximo (em horas) permitido para um usuário responder a uma mensagem de um agente antes que a janela de início da conversa se feche e a mensagem seja classificada como um evento single_message . | 24 |
max_duration_a2p_conversation | número | Duração máxima de uma conversa A2P, em horas. Medida desde a primeira resposta do usuário até a mensagem inicial do agente. | 24 |
max_duration_p2a_conversation | número | Duração máxima de uma conversa P2A, em horas. Medida a partir da primeira mensagem do usuário na conversa. | 24 |
start_time | AAAA-mm-ddTHH:00:00Z | A data e hora UTC de início do evento, no formato ISO 8601, arredondadas para a hora mais próxima. Mensagens A2P
Mensagens P2A
| 2019-07-25T08:00:00Z |
duration | número | Duração do evento, arredondada para o minuto mais próximo. O valor é 0 para qualquer evento que não seja conversacional. | 45 |
mt_messages | número | Número de mensagens A2P (terminadas em dispositivos móveis) no evento. | 11 |
mo_messages | número | Número de mensagens originadas em dispositivos móveis (P2A) no evento. | 9 |
size_kilobytes | número | Tamanho de todos os arquivos anexados às mensagens no evento, arredondado para o kilobyte mais próximo (1 kB é igual a 1024 bytes). | 912 |
agent_name | corda | Nome do agente que participou do evento. | XYZ Mobile USA |
owner_name | corda | Nome do proprietário atual da conta de parceiro onde o agente foi criado. | XYZ Mobile |
Exemplo de relatório de faturamento
Relatórios de exemplo estão disponíveis para download:
Tamanho típico do arquivo
O tamanho de um relatório diário de um parceiro RCS for Business ativo depende da quantidade de atividade gerada na rede da operadora. Por exemplo, se o relatório contiver 53.000 registros, o arquivo terá aproximadamente 8 MB.
Registros de atividades
Os registros de atividades fornecem dados brutos sobre a atividade na plataforma RCS for Business. Você pode usar esses registros para auditar eventos faturáveis e criar eventos personalizados.
Como os registros de atividades contêm informações de identificação pessoal (PII), como informações detalhadas de transações e números MSISDN dos assinantes, eles só estão disponíveis quando uma operadora utiliza o RCS de acordo com seus próprios Termos de Serviço. Se você utiliza o RCS para tráfego empresarial em suas redes e habilita a atividade RCS com o Google RCS, também de acordo com os Termos de Serviço do Google, você não terá acesso aos registros de atividades.
Formato do registro de atividades
Os registros de atividades utilizam o formato de nome de arquivo rbm_activity_YYYY-MM-DD.csv . A data no nome do arquivo é a data de geração do arquivo.
Os campos em um registro são separados por tabulação, e há um registro por linha.
Cada registro no diário de atividades contém os seguintes campos para cada atividade:
| Campo | Formatar | Descrição | Exemplo |
|---|---|---|---|
activity_id | corda | Identificador único para a atividade. | b422e1d3-ac99-442a-853d-a875d5e61762 |
billing_event_id | corda | Identificador único para o evento faturável associado. Pode estar vazio se a atividade não estiver associada a um evento faturável, como uma text_message sem delivery_receipt_event correspondente. | 91yeb201-7c3b-412b-98d2-b0a0f7abe536 |
agent_id | corda | Identificador único para o agente. | welcome-bot@rbm.goog |
user_id | corda | MSISDN do usuário. | 918369110173 |
direction | corda | A direção para onde a mensagem é enviada:
| MT |
time | AAAA-mm-ddTHH:MM:SS.SSSZ | Data e hora em que o evento foi submetido à plataforma RCS for Business, no formato UTC. Consulte Carimbos de data/hora . | 2019-07-25T00:29:07.033Z |
type | corda | Tipo de atividade:
| text_message |
size_bytes | corda | Tamanho dos arquivos anexados à atividade, em bytes. | 912 |
Carimbos de data/hora
Os registros de data e hora nos logs de atividades indicam quando um evento foi enviado para a plataforma RCS for Business. Para eventos que entregam conteúdo a um usuário, o evento não será registrado no log de atividades até que a mensagem seja entregue.
Por exemplo, se uma mensagem RCS for Business for enviada a um usuário na quarta-feira às 13h e o destinatário ficar offline até domingo às 9h, o evento aparecerá no registro de atividades gerado para domingo, mas o carimbo de data/hora será de quarta-feira, às 13h.