RBM tworzy pliki danych, które raportują aktywność użytkowników i agentów na poziomie podsumowania i transakcji. Dane są podzielone na kilka plików:
| Plik | Opis | Kto ma dostęp |
|---|---|---|
| Raport Zdarzenia rozliczeniowe | Rejestr zdarzeń podlegających rozliczeniu między uruchomionymi agentami a użytkownikami | Wszyscy operatorzy z ruchem RBM w swoich sieciach |
| Historia aktywności | Nieprzetworzone dane aktywności na platformie RBM | Operatorzy, którzy przekazują ruch RBM w swoich sieciach i włączają aktywność RCS w Jibe Cloud zgodnie z własnymi Warunkami korzystania z usługi |
Generowanie
Generowanie raportów o zdarzeniach rozliczeniowych i dzienników aktywności jest opóźnione o 2 dni.
Google zgłasza zdarzenie związane z aktywnością tylko wtedy, gdy sesja płatności, do której należy, zostanie zakończona. Sesja może potrwać do 24 godzin, a nasz system rozliczeniowy jest realizowany raz dziennie i raportuje tylko te sesje rozliczeniowe, które na pewno już się zakończyły (czyli mają co najmniej 24 godziny).
Na przykład:
Komunikat jest wysyłany d dnia i inicjuje sesję rozliczeniową, ale wykonanie potoku nie zostało wykonane godzinę wcześniej. W związku z tym nie rejestrujemy żadnych zdarzeń związanych z aktywnością.
Po ponownym uruchomieniu potoku w d+1 sesja zainicjowana przez wiadomość ma tylko 23 godziny. Dlatego w przypadku tej wiadomości nie jest raportowane żadne zdarzenie związane z aktywnością.
Gdy potok zostanie uruchomiony ponownie w d+2, sesja się zakończy, więc zdarzenie związane z aktywnością będzie raportowane razem z sesją rozliczeniową.
Miejsce na dane i dostęp
Pliki danych są szyfrowane w spoczynku i podczas przesyłania.
Aby pobrać pliki danych przez SFTP, musisz podać swój klucz publiczny SFTP. Informacje o generowaniu kluczy znajdziesz w artykule o generowaniu pary kluczy SSH do użycia ze skrzynką referencyjną SFTP.
Serwer SFTP to partnerupload.google.com, a połączenie jest wykonywane przez duży port (19321), aby zwiększyć bezpieczeństwo.
Do plików danych możesz uzyskać dostęp za pomocą tego polecenia:
sftp -i <path_to_private_key> -P 19321 <username>@partnerupload.google.com
Google udostępnia nazwy użytkowników kont w następujących formatach:
rbmreports-billableevents-<carrier name>rbmreports-activity-<carrier name>
Google określa <carrier name>i przy każdym typie raportu zapewnia oddzielne konto.
Masz osobne konta, które umożliwiają dostęp do różnych typów raportów.
Dostępność plików
Jeśli nie zostały jeszcze wygenerowane żadne pliki raportów, zobaczysz błąd SFTP podobny do remote readdir("/"): No such file or directory. To normalne.
Jeśli nie ma ruchu RBM do zgłoszenia, plik nie zostanie wygenerowany. Oznacza to, że czasami pliki mogą nie zostać wygenerowane. Jeśli w takiej sytuacji potrzebujesz wygenerowania pustych plików, by uprościć przetwarzanie, wyślij e-maila na adres rbm-support@google.com.
Odświeżanie i utrzymywanie
Każdy plik danych przedstawia 1 dzień użytkowania platformy w czasie UTC. Rekordy z danego dnia są generowane raz i finalizowane w ciągu 2 dni (48 godzin) od jego zakończenia. Po wczytaniu tych plików do hurtowni danych możesz zaktualizować wskaźniki z bieżącego miesiąca.
Jeśli nie ma aktywności, którą można uwzględnić, plik nie zostanie wygenerowany.
Data w nazwie każdego pliku to data jego wygenerowania. Rekordy w pliku będą obejmować dzień UTC przypadający na 2 dni przed datą utworzenia pliku.
Proces eksportu generujący pliki jest wykonywany między 2:00 a 4:00 czasu PST.
Pliki danych są przechowywane przez maksymalnie 30 dni, zanim zostaną usunięte.
Raporty zdarzeń rozliczeniowych
Raporty zdarzeń rozliczeniowych to rejestry zdarzeń podlegających rozliczeniu obliczone na podstawie wiadomości bazujących na sugerowanych jednostkach rozliczeniowych. Zdarzenia podlegające rozliczeniu zawierają informacje poufne, ale nie zawierają informacji umożliwiających identyfikację użytkownika (np. brak w danych numerycznych, identyfikator w postaci zaszyfrowanej ani unikalnego identyfikatora użytkownika).
Tylko uruchomione agenty generują zdarzenia rozliczeniowe. W raportach rozliczeniowych nie są widoczne informacje o działaniach, które jeszcze nie zostały uruchomione lub które nie zostały jeszcze uruchomione.
W raportach rozliczeniowych opłaty za zdarzenia są naliczane w momencie dostarczenia wiadomości, a nie po wysłaniu wiadomości. Niedostarczona lub odwołana wiadomość nie aktywuje zdarzenia rozliczeniowego.
Każdy agent RBM ma kategorię płatności ustawioną przez programistę przed przesłaniem agenta do uruchomienia. Kategoria płatności określa, czy wiadomości wysyłane przez agenta są osobne, czy mogą być łączone w zdarzenia płatności konwersacyjne.
Wyróżniamy 5 typów zdarzeń podlegających rozliczeniu:
| Zdarzenie | Definicja |
|---|---|
| Podstawowa wiadomość | przekaz A2P,
Tylko agenty konwersacyjne: jeśli wiadomość P2A zostanie dostarczona jako odpowiedź na wiadomość A2P w ciągu najbliższych 24 godzin, wiadomość podstawowa staje się częścią rozmowy A2P. W przeciwnym razie sesja zostaje zakończona. Wiadomość podstawowa jest zawsze dostarczana od agenta do użytkownika. |
| Pojedyncza wiadomość | przekaz A2P,
Tylko agenty konwersacyjne: jeśli wiadomość P2A zostanie dostarczona w ciągu najbliższych 24 godzin, pojedyncza wiadomość staje się częścią rozmowy A2P. W przeciwnym razie sesja zostaje zakończona. Pojedyncza wiadomość jest zawsze dostarczana od agenta do użytkownika. |
| Rozmowa A2P | Dotyczy tylko agentów konwersacyjnych: rozmowa A2P jest inicjowana, gdy wiadomość P2A zostanie dostarczona w ciągu 24 godzin od pojedynczej wiadomości A2P lub wiadomości A2P Basic. Pamiętaj, że jeśli wiadomość P2A zostanie dostarczona w ciągu 24 godzin od otrzymania większej liczby wiadomości A2P, do utworzenia sesji rozmowy zostanie użyta tylko wiadomość A2P bezpośrednio poprzedzająca wiadomość P2A. Ta wiadomość A2P oraz wszystkie wiadomości dostarczone w ciągu najbliższych 24 godzin są częścią nowej rozmowy A2P. |
| Rozmowa P2A | Dotyczy tylko agentów konwersacyjnych: rozmowa P2A jest inicjowana, gdy nie ma aktywnej sesji (pojedyncza wiadomość A2P, rozmowa A2P lub rozmowa P2A) i wiadomość P2A zostanie dostarczona, a firma odpowie w ciągu 24 godzin. |
| Wiadomość P2A | Agenty niekonwencyjne: wiadomość P2A wysłana przez użytkownika do agenta, której kategoria rozliczeniowa to Jedna wiadomość lub Podstawowa wiadomość.
Agenty konwersacyjne: wiadomość P2A wysłana od użytkownika do agenta, w przypadku której nie ma żadnej rozmowy, a agent nie zwraca odpowiedzi. |
Dostępność
Raporty o zdarzeniach rozliczeniowych są dostępne dla wszystkich operatorów, w których ruch RBM jest realizowany w swoich sieciach.
Format
Raporty zdarzeń rozliczeniowych mają format nazwy pliku YYYY/MM/DD/rbm_billable_events_YYYY-MM-DD.csv.
Data w nazwie pliku to data wygenerowania pliku. Rekordy w pliku zwykle obejmują aktywność z dnia poprzedzającego tę datę.
Pola w rekordzie są rozdzielone tabulatorami, a w każdym wierszu znajduje się 1 rekord.
Każde zdarzenie rozliczeniowe będzie miało jeden rekord. Oznacza to, że 2 rozmowy A2P z tym samym agentem spowodują wygenerowanie 2 zdarzeń dotyczących rozliczeń i 2 rekordów w raporcie rozliczeniowym.
Każdy rekord w raporcie o zdarzeniach podlegających rozliczeniu zawiera następujące informacje o każdym zdarzeniu:
| Pole | Format | Opis | Przykład |
|---|---|---|---|
billing_event_id
|
ciąg znaków | Identyfikator UUID, czyli liczba losowa, generowany dla każdego nowego zdarzenia w momencie jego utworzenia. | |
type
|
ciąg znaków | Typ zdarzenia:
|
single_message
|
agent_id
|
ciąg znaków | Identyfikator agenta, który uczestniczył w zdarzeniu. | rbm-welcome-bot@rbm.goog
|
agent_owner
|
ciąg znaków | Adres e-mail właściciela agenta, który uczestniczył w wydarzeniu. Jest to strona, która zarejestrowała agenta RBM, w większości przypadków pośrednik, ale w niektórych przypadkach może to być marka. Ta wartość jest pobierana z pola „Konto Google RBM”, które zostało udostępnione, gdy deweloper rejestrował się w RBM. | name@aggregator.com
|
billing_party
|
ciąg znaków | Podmiot, który rozlicza opłaty za wydarzenia.
|
carrier
|
max_duration_single_message
|
Liczba | Czas (w godzinach), przez jaki wiadomość agenta ma dotrzeć bez otrzymania odpowiedzi pozwalającej na zidentyfikowanie pojedynczej sesji wiadomości. | 24
|
max_duration_a2p_conversation
|
Liczba | Maksymalny czas trwania sesji A2P w godzinach. Mierzona od pierwszej odpowiedzi użytkownika na początkową wiadomość agenta. | 24
|
max_duration_p2a_conversation
|
Liczba | Maksymalny czas trwania sesji P2A w godzinach. Mierzona na podstawie pierwszej wiadomości użytkownika w rozmowie. | 24
|
start_time
|
YYYY-mm-ddTHH:00:00Z | Data i godzina rozpoczęcia zdarzenia UTC w formacie ISO 8601, zaokrąglona do najbliższej godziny.
|
2019-07-25T08:00:00Z
|
duration
|
Liczba | Czas trwania zdarzenia w zaokrągleniu do najbliższej minuty.
Gdy typem zdarzenia jest |
45
|
mt_messages
|
Liczba | Liczba wiadomości zakończonych na urządzeniach mobilnych w zdarzeniu. | 11
|
mo_messages
|
Liczba | Liczba wiadomości pochodzących ze zdarzenia na urządzeniach mobilnych. | 9
|
size_kilobytes
|
Liczba | Rozmiar wszystkich plików dołączonych do wiadomości w zdarzeniu, zaokrąglony do najbliższego kilobajta (1 kB = 1024 bajty). | 912
|
agent_name
|
ciąg znaków |
Agent, który uczestniczył w wydarzeniu. |
XYZ Mobile USA
|
owner_name
|
ciąg znaków | Właściciel agenta, który uczestniczył w wydarzeniu. Jest to strona, która zarejestrowała agenta RBM. W większości przypadków jest to pośrednik, ale w niektórych przypadkach może to być marka. Ta wartość jest pobierana z „Preferowanej wyświetlanej nazwy konta partnera” podanej, gdy deweloper rejestrował się do korzystania z RBM. | XYZ Mobile
|
Przykładowy plik
Przykładowy plik raportu rozliczeniowego jest dostępny do pobrania.
Typowy rozmiar pliku
Plik z dziennym raportem od aktywnego partnera może zawierać około 53 tys. rekordów i około 8 MB.
Dzienniki aktywności
Dzienniki aktywności to nieprzetworzony dziennik aktywności na platformie RBM służący do kontroli zdarzeń podlegających rozliczeniu oraz tworzenia zdarzeń niestandardowych.
Dostępność
Dzienniki aktywności są dostępne tylko dla operatorów, którzy w swoich sieciach obsługują ruch RBM i włączają aktywność RCS w Jibe Cloud zgodnie z własnymi Warunkami korzystania z usługi. Jeśli korzystasz z Jibe Cloud w ramach Warunków korzystania z usługi Jibe, nie będziesz mieć dostępu do logów aktywności.
Format
Historia aktywności ma format YYYY/MM/DD/rbm_activity_YYYY-MM-DD.csv.
Data w nazwie pliku to data wygenerowania pliku. Rekordy w pliku zwykle obejmują aktywność z dnia poprzedzającego tę datę.
Pola w rekordzie są rozdzielone tabulatorami, a w każdym wierszu znajduje się 1 rekord.
Każdy rekord w dzienniku aktywności zawiera poniższe pola dotyczące poszczególnych zdarzeń związanych z aktywnością.
| Pole | Format | Opis | Przykład |
|---|---|---|---|
activity_id
|
ciąg znaków | Identyfikator aktywności. | |
billing_event_id
|
ciąg znaków | Identyfikator zdarzenia rozliczeniowego, w którym wystąpiła aktywność. Może być pusta, jeśli aktywność nie jest powiązana z żadną sesją, np. text_message bez odpowiedniego delivery_receipt_event.
| |
agent_id
|
ciąg znaków | Identyfikator agenta. | welcome-bot@rbm.goog
|
user_id
|
ciąg znaków | Identyfikator MSISDN użytkownika. | 918369110173
|
direction
|
ciąg znaków | Kierunek wysyłania wiadomości:
|
MT
|
time
|
YYYY-mm-ddTHH:MM:SS.SSSZ | Data i godzina przesłania zdarzenia na platformę RBM (UTC). Zobacz uwagę poniżej. | 2019-07-25T00:29:07.033Z
|
type
|
ciąg znaków | Typ aktywności:
|
text_message
|
size_bytes
|
ciąg znaków | Rozmiar plików dołączonych do działania (w bajtach). | 912
|
Uwaga na temat sygnatur czasowych
Sygnatury czasowe w dziennikach aktywności rejestrują czas przesłania zdarzenia do platformy RBM. W przypadku zdarzeń, które dostarczają treści użytkownikowi, nie zostanie ono zapisane w dzienniku aktywności, dopóki wiadomość nie zostanie dostarczona.
Jeśli na przykład wiadomość RBM zostanie wysłana do użytkownika w środę o 13:00 i odbiorca będzie offline do niedzieli o 09:00, wydarzenie pojawi się w dzienniku aktywności wygenerowanym na potrzeby niedzieli. Sygnatura czasowa zdarzenia w Historii aktywności to środa, 13:00.