Skip to content

swagger-generated-README.md

Latest commit

 

History

History
111 lines (69 loc) · 3.17 KB

swagger-generated-README.md

File metadata and controls

111 lines (69 loc) · 3.17 KB
Raw

LoglyLift

Logly lift.json API for Lift Mobile SDK

This ObjC package is automatically generated by the Swagger Codegen project:

  • API version: 1.0.1
  • Package version: 0.9.12.2
  • Build package: io.swagger.codegen.languages.ObjcClientCodegen

Requirements

The SDK requires ARC (Automatic Reference Counting) to be enabled in the Xcode project.

Installation & Usage

Install from Github using CocoaPods

Add the following to the Podfile:

pod 'LoglyLift', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

To specify a particular branch, append , :branch => 'branch-name-here'

To specify a particular commit, append , :commit => '11aa22'

Install from local path using CocoaPods

Put the SDK under your project folder (e.g. /path/to/objc_project/Vendor/LoglyLift) and then add the following to the Podfile:

pod 'LoglyLift', :path => 'Vendor/LoglyLift'

Usage

Import the following:

#import <LoglyLift/LGApiClient.h>
#import <LoglyLift/LGDefaultConfiguration.h>
// load models
#import <LoglyLift/LGInlineResponse200.h>
#import <LoglyLift/LGInlineResponse200Items.h>
// load API classes for accessing endpoints
#import <LoglyLift/LGDefaultApi.h>

Recommendation

It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issues.

Getting Started

Please follow the installation procedure and then run the following:

NSNumber* *adspotId = @789; // Lift adspot ID
NSNumber* *widgetId = @789; // Lift wiget ID
NSString* *url = @"url_example"; // キーとなるページ URL (MDL)
NSString* *ref = @"ref_example"; // リファラーURL（通常Mobileでは必要なし） (optional)
NSString* *toplevel = @"items"; // jsonトップレベルhash名: 通常は'items'を指定 (optional) (default to items)

LGDefaultApi *apiInstance = [[LGDefaultApi alloc] init];

// Liftレコメンデーション結果検索
[apiInstance requestLiftWithAdspotId:adspotId
    widgetId:widgetId
    url:url
    ref:ref
    toplevel:toplevel
              completionHandler: ^(LGInlineResponse200* output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Documentation for API Endpoints

All URIs are relative to https://l.logly.co.jp

Class Method HTTP request Description
LGDefaultApi requestLift GET /lift.json Liftレコメンデーション結果検索

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author