PayPal Gateway - 2013 Guía de usuario descargar pdf (Pagina 18)

Using the Reporting API

Using Report Templates

18 Gateway Reporting Developer Guide

Step 2. Get the metadata

Request to get the report’s metadata by calling getMetaDataRequest. See “Step 2. Get

the metadata” on page 15.

Step 3. Get the report data

Request to get the report data by calling getDataRequest. See “Step 3. Get the report

data” on page 15.

Scheduling a Report Template

You can schedule a report template to run on a daily, weekly, or monthly basis. The Reporting

API includes functionality to create schedules and to get the results of a scheduled report

template.

Step 1. Create a schedule

To create a schedule for a report template, call createScheduleRequest with the

following parameters.

createScheduleRequest(scheduleName, templateName, schedule)

Step 2. Get the results

To get the results of a scheduled report template that is run, call getScheduleRequest

with scheduleName as a parameter.

getScheduleRequest(schedulename)

reportParam(s) (Optional) paramName and paramValue for each reportParam that you

want to assign a value to. These parameters can be ones previously

saved in the report template or additional ones. The parameter values

take precedence over the values previously saved for the parameters in

the report template.

pageSize Number of rows of data per page. Default is 50.

scheduleName Name that you give to the schedule.

templateName Name of the report template to be scheduled.

schedule One of three values:

 daily

 weekly (select dayOfWeek value: Sunday, Monday, Tuesday,

Wednesday, Thursday, Friday, or Saturday)

 monthly (Specify dayOfMonth value as an integer from 1 to 31. If

you specify 30 when the month is 28 days long, the value is

corrected to 28.)

The time of the day starts at midnight the previous night. The value

daily, for example, means midnight the previous night to midnight

tonight.

1 2 ... 13 14 15 16 17 18 19 20 21 22 23 ... 123 124

Sin comentarios

PayPal Gateway - 2013 Guía de usuario Pagina 18