Mobile Platform as a Service:Referência de API

O componente MCDP fornece APIs de promoção e de tela inicial para integração com iOS.

APIs de promoção

Classe de interface de promoção

Esta classe é o ponto de entrada unificado para os recursos de promoção. Chame as APIs desta classe para implementar funcionalidades relacionadas a promoções.

@interface CDPPromotionInterface : NSObject
@end

Iniciar o componente

Definição da API

+ (void)start;

Descrição

Inicia o componente MCDP, inicializa todos os dados de promoção e pré-carrega as imagens de recursos.

Exemplo

[CDPPromotionInterface start];

Verificar a versão do componente MCDP

Definição da API

+ (NSString *)sdkVersion;

Descrição

Retorna o número da versão do componente MCDP.

Versões aplicáveis: esta API está disponível na versão 3.0.0 e posteriores.

Exemplo

NSString cdpVersion = [CDPPromotionInterface sdkVersion];

Reportar eventos de compartilhamento de anúncios

Definição da API

+ (NSString *)reportShareAdAction;

Descrição

Reporta eventos de compartilhamento de anúncios para exibir esses dados na página de desempenho da campanha no console MCDP. Os dados reportados incluem a quantidade de compartilhamentos e o número de dispositivos únicos que executaram a ação. A métrica de compartilhamentos representa o total de vezes que um anúncio em uma landing page de campanha foi compartilhado durante um período específico. A contagem de dispositivos únicos refere-se ao total de aparelhos distintos (deduplicados) que clicaram no botão de compartilhar na landing page da campanha dentro de um determinado intervalo de tempo. Para obter mais informações sobre a exibição desses dados, consulte Visualize desempenho da campanha.

Versões aplicáveis: esta API está disponível na versão 3.0.0 e posteriores.

Exemplo

[CDPPromotionInterface reportShareAdAction];

Propriedades de promoção

As propriedades de promoção incluem o nome da notificação de login, o nome da notificação de logout e a configuração para uso de informações de localização.

Definição das propriedades

@interface CDPPromotionInterface : NSObject

// User configuration items
@property (nonatomic, strong) NSString* loginNotificationName;  // The name of the logon notification. The default value is empty.
@property (nonatomic, strong) NSString* logoutNotificationName; // The name of the logoff notification. The default value is empty.
@property (nonatomic, assign) BOOL useLbsInfo;  // Specifies whether to use location information. The default value is NO.

@end

Descrição das propriedades

Exemplo

[CDPPromotionInterface sharedInstance].loginNotificationName = @"xxxx";

APIs de tela inicial

O MCDP fornece métodos em linguagem C para gerenciar a lógica da tela inicial:

1. Determinar se a tela inicial deve ser exibida

2. Abrir a tela inicial

3. Enviar uma notificação para fechar a tela inicial

Determinar se a tela inicial deve ser exibida

Definição da API

BOOL splashScreenExist(BOOL shouldShowSplashScreen);

Descrição

Determina se a tela inicial deve ser exibida com base em regras definidas pelo usuário e nas regras internas do MCDP.

Descrição do parâmetro

Exemplo

BOOL shouldShowSplash = YES;
// Logic to determine if a splash screen ad is needed....
shouldShowSplash = splashScreenExist(shouldShowSplash);

Abrir a tela inicial

Definição da API

UIWindow * APSplashScreenStart(void (^dismiss)(void));

Descrição

Abre a tela inicial e exibe o anúncio correspondente.

Descrição do parâmetro

Descrição do valor de retorno

Exemplo

UIWindow *splashWindow = APSplashScreenStart(^{
    // Callback for when the splash screen closes
    // do something ...
});

Notificação para fechar a tela inicial

Definição da API

void APWillKillSplashScreen(void);

Descrição

Após o framework concluir a inicialização e o carregamento, chame esta API para notificá-lo de que a tela inicial será fechada. O fechamento pode não ocorrer imediatamente após o envio da notificação.

Exemplo

APWillKillSplashScreen();