Campaign Manager 360 API . reportData

close()

Close httplib2 connections.

query(profileId, body=None, x__xgafv=None)

Executes an ad-hoc query and returns structured JSON payload data.

Args:
  profileId: string, Required. The Campaign Manager 360 user profile ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request body containing ad-hoc query parameters.
  "dateRange": { # Represents a date range. # Optional. The requested date range covering the report duration.
    "endDate": "A String",
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
    "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
    "startDate": "A String",
  },
  "dimensionFilters": [ # Optional. The list of dimension values on which report lines are filtered. Utilizes the existing legacy filter message `DimensionValue`.
    { # Represents a DimensionValue resource.
      "dimensionName": "A String", # The name of the dimension.
      "etag": "A String", # The eTag of this response for caching purposes.
      "id": "A String", # The ID associated with the value if available.
      "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
      "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
      "value": "A String", # The value of the dimension.
    },
  ],
  "dimensionNames": [ # Optional. The list of dimension names to group by.
    "A String",
  ],
  "maxResults": 42, # Optional. Maximum number of result rows to return per page. The default value is 100. The maximum allowed value is 1000. Values above 1000 will be coerced (clamped) down to 1000. Negative values will be rejected.
  "metricNames": [ # Required. The list of metric names to include.
    "A String",
  ],
  "pageToken": "A String", # Optional. Continuation token for paginating results.
  "sortBys": [ # Optional. Sort options across either requested dimensions or metrics.
    { # Specifies the sort configuration for a specific field in the report.
      "name": "A String", # Required. The dimension or metric field name to sort on.
      "sortOrder": "A String", # Optional. The sort order of this column.
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a response to report data request.
  "columnHeaders": [ # Output only. Ordered descriptors of the requested column fields.
    { # A column header in the report.
      "name": "A String", # Output only. The column name.
      "type": "A String", # Output only. The column type.
    },
  ],
  "nextPageToken": "A String", # Output only. Token to retrieve the next page of rows, or empty if end of results.
  "rows": [ # Output only. The resulting set of matching data rows.
    { # A row of report data.
      "values": [ # Output only. A single sequential list of all cell values matching column_headers indices exactly. - Metric cells that are suppressed due to Minimum Reporting Standard (MRS) privacy protection constraints return "-".
        "A String",
      ],
    },
  ],
  "totalRow": { # A row of report data. # Output only. Singular aggregate total row for the entire query matching the criteria. Column headers apply in the exact same order as data rows. In the total_row: - All dimension columns contain an empty string (""), as aggregation does not apply. - Non-summable metric columns (e.g. Reach metrics) contain an empty string (""), as grand total aggregation cannot be mathematically/logically computed for them.
    "values": [ # Output only. A single sequential list of all cell values matching column_headers indices exactly. - Metric cells that are suppressed due to Minimum Reporting Standard (MRS) privacy protection constraints return "-".
      "A String",
    ],
  },
}

query_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.