Steps for Executing Reports

Steps that are used to execute reports are divided into 5 categories. Each of these categories is available as a submodule of ppc_robot_lib.steps.

input

Load data from external sources. This can be for example AdWords, Sklik, database, or even more complex logic like URL check.

control

Control statements – currently table deletion and loops over list of managed accounts.

transformations

Transforms tabular data – filtering, aggregation, computation of new columns etc.

persistence

Saving current state. Currently, no steps are implemented.

output

Output data to Google Spreadsheets. More output options are to come.

Contents:

• Input Steps
  • AdWords
  • Sklik
  • URL Check
  • PPC Robot’s Database
• Control Steps
  • DeleteTableStep
  • Context Manipulation
  • Client Account Loops
• Transformations
  • Filtering, splitting and merging
  • Grouping and Aggregations
  • Computation
  • Sorting
  • Utility Operations
• Output Steps
  • Notifications
  • Generic Output Step
• Other Steps
  • FunctionStep
• Utility Functions
  • Conditions

AbstractStep

Each step must implement the ppc_robot_lib.steps.abstract_step.AbstractStep class.

class AbstractStep

Abstract base class for all steps. Each step is required to implement at least the execute method.

Each step should also add its own properties, which represents parameters of the step.

abstract execute(task_ctx)

Executes the logic of the step. Must be implemented in subclasses. :type task_ctx: TaskContextInterface :param task_ctx: Task context which contains account credentials.

Return type:

StepPerformance | None

get_label()

Returns:

Label describing the step. The default implementation returns step name together with representation of object from get_label_args().

get_label_args()

Gets a list of arguments of the current step that is used to represent step arguments in label. :rtype: Any | None :return: Any object that represents arguments of the current step.

classmethod get_name()

Returns:

Short name of the step, e.g. FilterStep.