Qualificação
O GTAF PODE emitir a seguinte solicitação de qualificação para verificar se um usuário está qualificado para comprar um plano.
GET DPA/{userKey}/Eligibility/{planId}?key_type={CPID,MSISDN}
planId
é o identificador exclusivo do plano que pode ser usado para
comprar o plano em nome do usuário (consulte Compra de dados).
Se planId
não for especificado, o DPA vai retornar todos os planos que podem ser comprados por esse
usuário.
Casos de erro lista as respostas esperadas da DPA em caso de erro. Além disso, o DPA VAI retornar um erro nos seguintes casos:
- A DPA retorna um código de erro 400 BAD REQUEST indicando ao GTAF que
planId
é inválido. - A DPA retorna um código de erro 409 CONFLICT indicando que
planId
é incompatível com o plano de dados do usuário.
Caso contrário, o DPA vai retornar uma resposta 200-OK. O formato de uma EligibilityResponse bem-sucedida é:
{
"eligiblePlans":
[
{
"planId": string, // Plan identifier. Can be used to
// refer to the plan during
// offers, etc. (req.)
}
]
}
Quando a solicitação inclui um planId
, a resposta inclui apenas esse plano. Caso contrário, a lista inclui todos os planos que o usuário pode
comprar. Se planId
estiver vazio e a DPA não oferecer suporte ao retorno da lista de planos qualificados, ela precisará retornar um erro 400 BAD REQUEST.
Experiências 5G do Android
O GTAF permite que as operadoras compartilhem o status de medição por tipo de conexão para assinantes. As informações podem ser extraídas periodicamente pelo GTAF ou enviadas pelas operadoras com base em gatilhos internos.
API Pull
O dispositivo pode extrair as informações de medição via GTAF usando o seguinte:
GET DPA/{userKey}/planStatus?key_type={userKey}&client_id=AndroidSystemInfo
O DPA (Data Plan Agent) representa um gateway de API ou um servidor de direitos na rede da operadora.
userKey é o token de autenticação estabelecido durante a fase inicial de autenticação conforme definido aqui.
client_id é AndroidSystemInfo
O status de limitação é fornecido como um ENUM.
A DPA vai retornar uma resposta 200 OK e incluir planInfoPerClient. O tratamento de erros para a DPA está definido aqui.
No modelo de extração, o GTAF atua como um cliente e valida o certificado SSL do DPA. O GTAF se autentica no DPA usando o procedimento OAuth definido aqui.
API Push
A operadora também pode enviar as informações de medição usando o seguinte com base em um evento de acionamento, como mudança de plano de preços etc.
POST https://mobiledataplansharing.googleapis.com/v1/operators/12345/clients/AndroidSystemInfo/users/abcdef/planStatus
A DPA precisa incluir planInfoPerClient no corpo da mensagem. As respostas de erro da GTAF estão definidas aqui.
No modo push, o GTAF autentica as solicitações recebidas do DPA usando o servidor OAuth2 do Google Cloud. As solicitações recebidas precisam ser autenticadas como uma conta de serviço que foi adicionada à lista de permissões no Portal do ISP para o ASN representado pelo DPA. Consulte também o guia de integração aqui para mais detalhes.