Métodos do Target para iOS

Esta é uma lista de métodos do Adobe Target fornecidos pela biblioteca do iOS.

Atualmente, o SDK é compatível com várias soluções da Adobe Experience Cloud, como o Analytics, o Target, o Audience Manager e o Adobe Experience Platform Identity Service. Os métodos apresentam prefixos de acordo com a solução. Por exemplo, os métodos do têm o prefixo target target.

DICA

Medições de ciclo de vida são enviadas como parâmetros para cada carregamento de mbox. Para obter mais informações, consulte Medições de ciclo de vida. Se você estiver enviando solicitações do Target dentro do método delegado didFinishLaunching, adicione uma chamada [ADBMobile trackAction:data:] ou [ADBMobile trackState:data:] antes do código de implementação do Target. Dessa forma, as solicitações do Target conterão os dados completos do ciclo de vida.

Referência de classe: ADBTargetLocationRequest

Propriedades

NSString *name;
NSString *defaultContent;
NSMutableDictionary *parameters;

Constantes da cadeia de caracteres

DICA

As constantes seguintes facilitam o uso ao configurar as chaves para parâmetros personalizados.

NSString *const ADBTargetParameterOrderId;
NSString *const ADBTargetParameterOrderTotal;
NSString *const ADBTargetParameterProductPurchasedId;
NSString *const ADBTargetParameterCategoryId;
NSString *const ADBTargetParameterMbox3rdPartyId;
NSString *const ADBTargetParameterMboxPageValue;
NSString *const ADBTargetParameterMboxPc;
NSString *const ADBTargetParameterMboxSessionId;
NSString *const ADBTargetParameterMboxHost;
IMPORTANTE

  • Se você estiver usando SDKs anteriores à versão 4.14.0, consulte Parâmetros de entrada para limitações de parâmetros.

  • Se você estiver usando a versão 4.14.0 ou posterior dos SDKs, consulte Parâmetros de entrada de lotes para limitações de parâmetros.

Métodos

  • targetLoadRequest:​callback

    Envia request para o servidor do Target configurado e retorna o valor da cadeia de caracteres da oferta gerada em um callback de bloqueio.

    • Esta é a sintaxe para este método:

      + (void) targetLoadRequest:(ADBTargetLocationRequest *)request
                  callback:(void (^)(NSString *content))callback;

    • Esta é a amostra de código para este método:

      [ADBMobile targetLoadRequest:myRequest
                    callback:^(NSString *content) {
                      // do something with content
                    }];

  • targetLoadRequestWithName:defaultContent:profileParameters:orderParameters:mboxParameters:requestLocationParameters:retorno de chamada:

    Envia uma solicitação para o servidor do Target configurado e retorna o valor da cadeia de caracteres da oferta gerada em um retorno de chamada.

    • Esta é a sintaxe para este método:

      + (void) targetLoadRequestWithName:(nullable NSString *)name
                    defaultContent:(nullable NSString *)defaultContent
                profileParameters:(nullable NSDictionary *)profileParameters
                  orderParameters:(nullable NSDictionary *)orderParameters
                   mboxParameters:(nullable NSDictionary *)mboxParameters
          requestLocationParameters:(nullable NSDictionary *)requestLocationParameters
                           callback:(nullable void (^)(NSString
                           * __nullable content))callback;

    • Retorna: N/A

    • Estes são os parâmetros para este método:

      • name

        Nome da mbox/localização do Target que você quer recuperar.

        • Tipo: NSString*

      • defaultContent

        O valor retornado no retorno de chamada se não for possível alcançar o servidor do Target, ou se o usuário não estiver qualificado para a campanha.

        • Tipo: NSString*

      • profileParameters

        Os valores neste dicionário serão adicionados ao objeto "profileParameters" na solicitação para o Target.

        • Tipo: NSDictionary*

      • orderParameters

        Os valores neste dicionário serão adicionados ao objeto "order" na solicitação para o Target.

        • Tipo: NSDictionary

      • mboxParameters

        Os valores neste dicionário serão adicionados ao objeto "mboxParameters" na solicitação para o Target.

        • Tipo: NSDictionary*

      • requestLocationParameters

        Os valores neste dicionário serão adicionados ao objeto "requestLocation" na solicitação para o Target.

        Tipo: NSDictionary*

      • callback

        Este método será chamado com o conteúdo da oferta do servidor Target. Se o servidor Target estiver inacessível, ou o usuário não se qualificar para a campanha, defaultContent será retornado.
        Tipo: função

    • Esta é a amostra de código para este método:

      [ADBMobile targetLoadRequestWithName:@"myHeroBanner"
                      defaultContent:@"defaultHeroBanner.png"
                  profileParameters:@{@"age":@"20-29"}
                    orderParameters:nil
                     mboxParameters:@{@"customParam":@"customValue"}
          requestLocationParameters:@{@"host":@"my.hostname.com"}
                           callback:^(NSString *content){
                             // do something with content
                             myImageView.image = [UIImage imageNamed:content];
                           }];

      Para obter mais informações sobre a API subjacente do Target, consulte Referência da API do Target.

  • targetLoadRequestWithName:defaultContent:profileParameters:orderParameters:mboxParameters:callback

    Envia a solicitação para o servidor do Target configurado e retorna o valor da cadeia de caracteres da oferta gerada em um retorno de chamada de bloqueio.

    • Esta é a sintaxe para este método:

      + (void) targetLoadRequestWithName:(nullable NSString *)name
                    defaultContent:(nullable NSString *)defaultContent
                profileParameters:(nullable NSDictionary *)profileParameters
                  orderParameters:(nullable NSDictionary *)orderParameters
                   mboxParameters:(nullable NSDictionary *)mboxParameters
                         callback:(nullable void (^)(NSString * __nullable content))callback;

    • Esta é a amostra de código para este método:

      [ADBMobile targetLoadRequestWithName:@"mboxName"
                      defaultContent:@"defaultContent"
                   profileParameters:{@"profile-parameter-key": @"profile-parameter-value"}
                     orderParameters:@{@"order-parameter-key": @"order-parameter-value"}
                      mboxParameters:@{@"mbox-parameter-key": @"mbox-parameter-value"}
                             callback:^(NSString * content) {
                                     //do something with content
                           }
                         }];

  • targetCreateOrder​ConfirmRequestWithName:​orderId:​orderTotal:​productPurchasedId:​parameters

    Cria um ADBTargetLocationRequest.

    • Esta é a sintaxe para este método:

      + (ADBTargetLocationRequest *)
targetCreateOrderConfirmRequestWithName:(NSString *)name
                                orderId:(NSString *)orderId
                            orderTotal:(NSString *)orderTotal
                    productPurchasedId:(NSString *)productPurchasedId
                        parameters:(NSDictionary *)parameters;

  • targetCreateRequestWithName:​​defaultContent:​parameters

    O construtor de conveniência cria um objeto ADBTargetLocationRequest com os parâmetros em questão.

    • Esta é a sintaxe para este método:

      + (ADBTargetLocationRequest *)
targetCreateRequestWithName:(NSString *)name
                     defaultContent:(NSString *)defaultContent
                         parameters:(NSDictionary *)parameters;

    • Esta é a amostra de código para este método:

      ADBTargetLocationRequest *myRequest =
[ADBMobile targetCreateRequestWithName:@"heroBanner"
                        defaultContent:@"default.png"
                            parameters:nil];

  • targetThirdPartyID

    Retorna a ID de terceiros.

    • Esta é a sintaxe para este método:

      + (nullable NSString *) targetThirdPartyID;

    • Esta é a amostra de código para este método:

      NSString *thirdPartyId = [ADBMobile targetThirdPartyID];

  • targetSetThirdPartyID

    Define a ID de terceiros.

    • Esta é a sintaxe para este método:

      + (void) targetSetThirdPartyID:(nullable NSString *)thirdPartyID;

    • Esta é a amostra de código para este método:

      [ADBMobile targetSetThirdPartyID:@"thirdPartyID"];

  • targetClearCookies

    Apaga quaisquer cookies de destino do seu aplicativo.

    DICA

    Desde a versão 4.10.0 do SDK, o Target não usa mais cookies. Esse método redefine thirdPartyID e sessionID.

    • Esta é a sintaxe para este método:

      + (void) targetClearCookies;

    • Esta é a amostra de código para este método:

      [ADBMobile targetClearCookies];

  • targetPcID

    Retorna a PcID.

    • Esta é a sintaxe para este método:

      + (nullable NSString *) targetPcID;

    • Esta é a amostra de código para este método:

      NSString *myTargetPcID = [ADBMobile targetPcID];

  • targetSessionID

    Retorna o SessionID.

    • Esta é a sintaxe para este método:

      + (nullable NSString *) targetPcID;

    • Esta é a amostra de código para este método:

      NSString *myTargetSessionID = [ADBMobile targetSessionID];

Exemplo

// make your request
ADBTargetLocationRequest *myRequest =
 [ADBMobile targetCreateRequestWithName:@"heroBanner"
                         defaultContent:@"default.png"
                          parameters:nil];
// load your request
[ADBMobile targetLoadRequest:myRequest
                    callback:^(NSString *content) {
                        // do something with content
                        heroImage.image = [UIImage imageNamed:content];
                    }];

Nesta página