DFA Reporting API . reports

Instance Methods

files()

Returns the files Resource.

delete(profileId, reportId)

Deletes a report by its id.

get(profileId, reportId)

Retrieves a report by its id.

insert(profileId, body)

Creates a report.

list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)

Retrieves list of reports.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, reportId, body)

Updates a report. This method supports patch semantics.

run(profileId, reportId, synchronous=None)

Runs a report.

update(profileId, reportId, body)

Updates a report.

Method Details

delete(profileId, reportId)
Deletes a report by its id.

Args:
  profileId: string, The DFA user profile id. (required)
  reportId: string, The id of the report. (required)
get(profileId, reportId)
Retrieves a report by its id.

Args:
  profileId: string, The DFA user profile id. (required)
  reportId: string, The id of the report. (required)

Returns:
  An object of the form:

    { # Represents a Report resource.
      "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
      "name": "A String", # The name of the report.
      "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
        "startDate": "A String", # Start date of date range for which scheduled reports should be run.
        "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
            # - DAY_OF_MONTH
            # - WEEK_OF_MONTH
            # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
        "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
        "expirationDate": "A String", # The expiration date when the scheduled report stops running.
        "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
        "repeats": "A String", # The interval the report is repeated for, one of:
            # - "DAILY", also requires field "every" to be set.
            # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "TWICE_A_MONTH"
            # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
            # - "QUARTERLY"
            # - "YEARLY"
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
          "A String",
        ],
      },
      "ownerProfileId": "A String", # The user profile id of the owner of this report.
      "fileName": "A String", # The file name used when generating report files for this report.
      "etag": "A String", # ETag of this response for caching purposes.
      "criteria": { # The report criteria.
        "activities": { # Activity group.
          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
            { # Represents a DimensionValue resource.
              "dimensionName": "A String", # Name of the dimension.
              "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
              "etag": "A String", # ETag of this response for caching purposes.
              "id": "A String", # The ID associated with the value if available.
              "value": "A String", # The value of the dimension.
            },
          ],
          "metricNames": [ # List of names of floodlight activity metrics.
            "A String",
          ],
        },
        "dimensions": [ # The list of dimensions the report should include.
          { # Represents a sorted dimension.
            "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
            "name": "A String", # The name of the dimension.
            "sortOrder": "A String", # An optional sort order for the dimension column, one of:
                # - "ASCENDING"
                # - "DESCENDING"
          },
        ],
        "metricNames": [ # The list of names of metrics the report should include.
          "A String",
        ],
        "dateRange": { # The date range this report should be run for.
          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
          "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
              # - "TODAY"
              # - "YESTERDAY"
              # - "WEEK_TO_DATE"
              # - "MONTH_TO_DATE"
              # - "QUARTER_TO_DATE"
              # - "YEAR_TO_DATE"
              # - "PREVIOUS_WEEK"
              # - "PREVIOUS_MONTH"
              # - "PREVIOUS_QUARTER"
              # - "PREVIOUS_YEAR"
              # - "LAST_7_DAYS"
              # - "LAST_30_DAYS"
              # - "LAST_90_DAYS"
              # - "LAST_365_DAYS"
              # - "LAST_24_MONTHS"
          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
        },
        "dimensionFilters": [ # The list of filters dimensions are filtered on.
            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
          { # Represents a DimensionValue resource.
            "dimensionName": "A String", # Name of the dimension.
            "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
            "etag": "A String", # ETag of this response for caching purposes.
            "id": "A String", # The ID associated with the value if available.
            "value": "A String", # The value of the dimension.
          },
        ],
        "customRichMediaEvents": { # Custom Rich Media Events group.
          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
            { # Represents a DimensionValue resource.
              "dimensionName": "A String", # Name of the dimension.
              "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
              "etag": "A String", # ETag of this response for caching purposes.
              "id": "A String", # The ID associated with the value if available.
              "value": "A String", # The value of the dimension.
            },
          ],
        },
      },
      "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
      "type": "A String", # The type of the report, currently only "STANDARD" is supported.
      "id": "A String", # The unique ID identifying this report resource.
      "accountId": "A String", # The account id this report belongs to.
    }
insert(profileId, body)
Creates a report.

Args:
  profileId: string, The DFA user profile id. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Report resource.
    "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
    "name": "A String", # The name of the report.
    "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
      "startDate": "A String", # Start date of date range for which scheduled reports should be run.
      "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
          # - DAY_OF_MONTH
          # - WEEK_OF_MONTH
          # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
      "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
      "expirationDate": "A String", # The expiration date when the scheduled report stops running.
      "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
      "repeats": "A String", # The interval the report is repeated for, one of:
          # - "DAILY", also requires field "every" to be set.
          # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "TWICE_A_MONTH"
          # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
          # - "QUARTERLY"
          # - "YEARLY"
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
        "A String",
      ],
    },
    "ownerProfileId": "A String", # The user profile id of the owner of this report.
    "fileName": "A String", # The file name used when generating report files for this report.
    "etag": "A String", # ETag of this response for caching purposes.
    "criteria": { # The report criteria.
      "activities": { # Activity group.
        "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
          { # Represents a DimensionValue resource.
            "dimensionName": "A String", # Name of the dimension.
            "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
            "etag": "A String", # ETag of this response for caching purposes.
            "id": "A String", # The ID associated with the value if available.
            "value": "A String", # The value of the dimension.
          },
        ],
        "metricNames": [ # List of names of floodlight activity metrics.
          "A String",
        ],
      },
      "dimensions": [ # The list of dimensions the report should include.
        { # Represents a sorted dimension.
          "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
          "name": "A String", # The name of the dimension.
          "sortOrder": "A String", # An optional sort order for the dimension column, one of:
              # - "ASCENDING"
              # - "DESCENDING"
        },
      ],
      "metricNames": [ # The list of names of metrics the report should include.
        "A String",
      ],
      "dateRange": { # The date range this report should be run for.
        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
        "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
            # - "TODAY"
            # - "YESTERDAY"
            # - "WEEK_TO_DATE"
            # - "MONTH_TO_DATE"
            # - "QUARTER_TO_DATE"
            # - "YEAR_TO_DATE"
            # - "PREVIOUS_WEEK"
            # - "PREVIOUS_MONTH"
            # - "PREVIOUS_QUARTER"
            # - "PREVIOUS_YEAR"
            # - "LAST_7_DAYS"
            # - "LAST_30_DAYS"
            # - "LAST_90_DAYS"
            # - "LAST_365_DAYS"
            # - "LAST_24_MONTHS"
        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
      },
      "dimensionFilters": [ # The list of filters dimensions are filtered on.
          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
        { # Represents a DimensionValue resource.
          "dimensionName": "A String", # Name of the dimension.
          "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
          "etag": "A String", # ETag of this response for caching purposes.
          "id": "A String", # The ID associated with the value if available.
          "value": "A String", # The value of the dimension.
        },
      ],
      "customRichMediaEvents": { # Custom Rich Media Events group.
        "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
          { # Represents a DimensionValue resource.
            "dimensionName": "A String", # Name of the dimension.
            "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
            "etag": "A String", # ETag of this response for caching purposes.
            "id": "A String", # The ID associated with the value if available.
            "value": "A String", # The value of the dimension.
          },
        ],
      },
    },
    "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
    "type": "A String", # The type of the report, currently only "STANDARD" is supported.
    "id": "A String", # The unique ID identifying this report resource.
    "accountId": "A String", # The account id this report belongs to.
  }


Returns:
  An object of the form:

    { # Represents a Report resource.
      "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
      "name": "A String", # The name of the report.
      "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
        "startDate": "A String", # Start date of date range for which scheduled reports should be run.
        "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
            # - DAY_OF_MONTH
            # - WEEK_OF_MONTH
            # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
        "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
        "expirationDate": "A String", # The expiration date when the scheduled report stops running.
        "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
        "repeats": "A String", # The interval the report is repeated for, one of:
            # - "DAILY", also requires field "every" to be set.
            # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "TWICE_A_MONTH"
            # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
            # - "QUARTERLY"
            # - "YEARLY"
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
          "A String",
        ],
      },
      "ownerProfileId": "A String", # The user profile id of the owner of this report.
      "fileName": "A String", # The file name used when generating report files for this report.
      "etag": "A String", # ETag of this response for caching purposes.
      "criteria": { # The report criteria.
        "activities": { # Activity group.
          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
            { # Represents a DimensionValue resource.
              "dimensionName": "A String", # Name of the dimension.
              "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
              "etag": "A String", # ETag of this response for caching purposes.
              "id": "A String", # The ID associated with the value if available.
              "value": "A String", # The value of the dimension.
            },
          ],
          "metricNames": [ # List of names of floodlight activity metrics.
            "A String",
          ],
        },
        "dimensions": [ # The list of dimensions the report should include.
          { # Represents a sorted dimension.
            "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
            "name": "A String", # The name of the dimension.
            "sortOrder": "A String", # An optional sort order for the dimension column, one of:
                # - "ASCENDING"
                # - "DESCENDING"
          },
        ],
        "metricNames": [ # The list of names of metrics the report should include.
          "A String",
        ],
        "dateRange": { # The date range this report should be run for.
          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
          "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
              # - "TODAY"
              # - "YESTERDAY"
              # - "WEEK_TO_DATE"
              # - "MONTH_TO_DATE"
              # - "QUARTER_TO_DATE"
              # - "YEAR_TO_DATE"
              # - "PREVIOUS_WEEK"
              # - "PREVIOUS_MONTH"
              # - "PREVIOUS_QUARTER"
              # - "PREVIOUS_YEAR"
              # - "LAST_7_DAYS"
              # - "LAST_30_DAYS"
              # - "LAST_90_DAYS"
              # - "LAST_365_DAYS"
              # - "LAST_24_MONTHS"
          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
        },
        "dimensionFilters": [ # The list of filters dimensions are filtered on.
            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
          { # Represents a DimensionValue resource.
            "dimensionName": "A String", # Name of the dimension.
            "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
            "etag": "A String", # ETag of this response for caching purposes.
            "id": "A String", # The ID associated with the value if available.
            "value": "A String", # The value of the dimension.
          },
        ],
        "customRichMediaEvents": { # Custom Rich Media Events group.
          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
            { # Represents a DimensionValue resource.
              "dimensionName": "A String", # Name of the dimension.
              "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
              "etag": "A String", # ETag of this response for caching purposes.
              "id": "A String", # The ID associated with the value if available.
              "value": "A String", # The value of the dimension.
            },
          ],
        },
      },
      "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
      "type": "A String", # The type of the report, currently only "STANDARD" is supported.
      "id": "A String", # The unique ID identifying this report resource.
      "accountId": "A String", # The account id this report belongs to.
    }
list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
Retrieves list of reports.

Args:
  profileId: string, The DFA user profile id. (required)
  pageToken: string, The value of the nextToken from the previous result page.
  sortField: string, The field to sort the list by.
    Allowed values
      ID - Sort by report id.
      LAST_MODIFIED_TIME - Sort by 'lastModifiedTime' field.
      NAME - Sort by display name of reports.
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is 'DESCENDING'.
    Allowed values
      ASCENDING - Ascending order.
      DESCENDING - Descending order.

Returns:
  An object of the form:

    { # Represents the list of reports.
    "nextPageToken": "A String", # Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
    "items": [ # The reports returned in this response.
      { # Represents a Report resource.
          "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
          "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
          "name": "A String", # The name of the report.
          "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
            "startDate": "A String", # Start date of date range for which scheduled reports should be run.
            "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
                # - DAY_OF_MONTH
                # - WEEK_OF_MONTH
                # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
            "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
            "expirationDate": "A String", # The expiration date when the scheduled report stops running.
            "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
            "repeats": "A String", # The interval the report is repeated for, one of:
                # - "DAILY", also requires field "every" to be set.
                # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
                # - "TWICE_A_MONTH"
                # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
                # - "QUARTERLY"
                # - "YEARLY"
            "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
              "A String",
            ],
          },
          "ownerProfileId": "A String", # The user profile id of the owner of this report.
          "fileName": "A String", # The file name used when generating report files for this report.
          "etag": "A String", # ETag of this response for caching purposes.
          "criteria": { # The report criteria.
            "activities": { # Activity group.
              "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
                { # Represents a DimensionValue resource.
                  "dimensionName": "A String", # Name of the dimension.
                  "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
                  "etag": "A String", # ETag of this response for caching purposes.
                  "id": "A String", # The ID associated with the value if available.
                  "value": "A String", # The value of the dimension.
                },
              ],
              "metricNames": [ # List of names of floodlight activity metrics.
                "A String",
              ],
            },
            "dimensions": [ # The list of dimensions the report should include.
              { # Represents a sorted dimension.
                "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
                "name": "A String", # The name of the dimension.
                "sortOrder": "A String", # An optional sort order for the dimension column, one of:
                    # - "ASCENDING"
                    # - "DESCENDING"
              },
            ],
            "metricNames": [ # The list of names of metrics the report should include.
              "A String",
            ],
            "dateRange": { # The date range this report should be run for.
              "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
              "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
                  # - "TODAY"
                  # - "YESTERDAY"
                  # - "WEEK_TO_DATE"
                  # - "MONTH_TO_DATE"
                  # - "QUARTER_TO_DATE"
                  # - "YEAR_TO_DATE"
                  # - "PREVIOUS_WEEK"
                  # - "PREVIOUS_MONTH"
                  # - "PREVIOUS_QUARTER"
                  # - "PREVIOUS_YEAR"
                  # - "LAST_7_DAYS"
                  # - "LAST_30_DAYS"
                  # - "LAST_90_DAYS"
                  # - "LAST_365_DAYS"
                  # - "LAST_24_MONTHS"
              "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
            },
            "dimensionFilters": [ # The list of filters dimensions are filtered on.
                # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
              { # Represents a DimensionValue resource.
                "dimensionName": "A String", # Name of the dimension.
                "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
                "etag": "A String", # ETag of this response for caching purposes.
                "id": "A String", # The ID associated with the value if available.
                "value": "A String", # The value of the dimension.
              },
            ],
            "customRichMediaEvents": { # Custom Rich Media Events group.
              "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
                { # Represents a DimensionValue resource.
                  "dimensionName": "A String", # Name of the dimension.
                  "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
                  "etag": "A String", # ETag of this response for caching purposes.
                  "id": "A String", # The ID associated with the value if available.
                  "value": "A String", # The value of the dimension.
                },
              ],
            },
          },
          "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
          "type": "A String", # The type of the report, currently only "STANDARD" is supported.
          "id": "A String", # The unique ID identifying this report resource.
          "accountId": "A String", # The account id this report belongs to.
        },
    ],
    "kind": "dfareporting#reportList", # Kind of list this is, in this case dfareporting#reportList.
    "etag": "A String", # ETag of this response for caching purposes.
  }
list_next(previous_request, previous_response)
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.
      
patch(profileId, reportId, body)
Updates a report. This method supports patch semantics.

Args:
  profileId: string, The DFA user profile id. (required)
  reportId: string, The id of the report. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Report resource.
    "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
    "name": "A String", # The name of the report.
    "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
      "startDate": "A String", # Start date of date range for which scheduled reports should be run.
      "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
          # - DAY_OF_MONTH
          # - WEEK_OF_MONTH
          # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
      "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
      "expirationDate": "A String", # The expiration date when the scheduled report stops running.
      "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
      "repeats": "A String", # The interval the report is repeated for, one of:
          # - "DAILY", also requires field "every" to be set.
          # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "TWICE_A_MONTH"
          # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
          # - "QUARTERLY"
          # - "YEARLY"
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
        "A String",
      ],
    },
    "ownerProfileId": "A String", # The user profile id of the owner of this report.
    "fileName": "A String", # The file name used when generating report files for this report.
    "etag": "A String", # ETag of this response for caching purposes.
    "criteria": { # The report criteria.
      "activities": { # Activity group.
        "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
          { # Represents a DimensionValue resource.
            "dimensionName": "A String", # Name of the dimension.
            "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
            "etag": "A String", # ETag of this response for caching purposes.
            "id": "A String", # The ID associated with the value if available.
            "value": "A String", # The value of the dimension.
          },
        ],
        "metricNames": [ # List of names of floodlight activity metrics.
          "A String",
        ],
      },
      "dimensions": [ # The list of dimensions the report should include.
        { # Represents a sorted dimension.
          "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
          "name": "A String", # The name of the dimension.
          "sortOrder": "A String", # An optional sort order for the dimension column, one of:
              # - "ASCENDING"
              # - "DESCENDING"
        },
      ],
      "metricNames": [ # The list of names of metrics the report should include.
        "A String",
      ],
      "dateRange": { # The date range this report should be run for.
        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
        "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
            # - "TODAY"
            # - "YESTERDAY"
            # - "WEEK_TO_DATE"
            # - "MONTH_TO_DATE"
            # - "QUARTER_TO_DATE"
            # - "YEAR_TO_DATE"
            # - "PREVIOUS_WEEK"
            # - "PREVIOUS_MONTH"
            # - "PREVIOUS_QUARTER"
            # - "PREVIOUS_YEAR"
            # - "LAST_7_DAYS"
            # - "LAST_30_DAYS"
            # - "LAST_90_DAYS"
            # - "LAST_365_DAYS"
            # - "LAST_24_MONTHS"
        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
      },
      "dimensionFilters": [ # The list of filters dimensions are filtered on.
          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
        { # Represents a DimensionValue resource.
          "dimensionName": "A String", # Name of the dimension.
          "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
          "etag": "A String", # ETag of this response for caching purposes.
          "id": "A String", # The ID associated with the value if available.
          "value": "A String", # The value of the dimension.
        },
      ],
      "customRichMediaEvents": { # Custom Rich Media Events group.
        "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
          { # Represents a DimensionValue resource.
            "dimensionName": "A String", # Name of the dimension.
            "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
            "etag": "A String", # ETag of this response for caching purposes.
            "id": "A String", # The ID associated with the value if available.
            "value": "A String", # The value of the dimension.
          },
        ],
      },
    },
    "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
    "type": "A String", # The type of the report, currently only "STANDARD" is supported.
    "id": "A String", # The unique ID identifying this report resource.
    "accountId": "A String", # The account id this report belongs to.
  }


Returns:
  An object of the form:

    { # Represents a Report resource.
      "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
      "name": "A String", # The name of the report.
      "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
        "startDate": "A String", # Start date of date range for which scheduled reports should be run.
        "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
            # - DAY_OF_MONTH
            # - WEEK_OF_MONTH
            # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
        "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
        "expirationDate": "A String", # The expiration date when the scheduled report stops running.
        "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
        "repeats": "A String", # The interval the report is repeated for, one of:
            # - "DAILY", also requires field "every" to be set.
            # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "TWICE_A_MONTH"
            # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
            # - "QUARTERLY"
            # - "YEARLY"
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
          "A String",
        ],
      },
      "ownerProfileId": "A String", # The user profile id of the owner of this report.
      "fileName": "A String", # The file name used when generating report files for this report.
      "etag": "A String", # ETag of this response for caching purposes.
      "criteria": { # The report criteria.
        "activities": { # Activity group.
          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
            { # Represents a DimensionValue resource.
              "dimensionName": "A String", # Name of the dimension.
              "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
              "etag": "A String", # ETag of this response for caching purposes.
              "id": "A String", # The ID associated with the value if available.
              "value": "A String", # The value of the dimension.
            },
          ],
          "metricNames": [ # List of names of floodlight activity metrics.
            "A String",
          ],
        },
        "dimensions": [ # The list of dimensions the report should include.
          { # Represents a sorted dimension.
            "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
            "name": "A String", # The name of the dimension.
            "sortOrder": "A String", # An optional sort order for the dimension column, one of:
                # - "ASCENDING"
                # - "DESCENDING"
          },
        ],
        "metricNames": [ # The list of names of metrics the report should include.
          "A String",
        ],
        "dateRange": { # The date range this report should be run for.
          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
          "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
              # - "TODAY"
              # - "YESTERDAY"
              # - "WEEK_TO_DATE"
              # - "MONTH_TO_DATE"
              # - "QUARTER_TO_DATE"
              # - "YEAR_TO_DATE"
              # - "PREVIOUS_WEEK"
              # - "PREVIOUS_MONTH"
              # - "PREVIOUS_QUARTER"
              # - "PREVIOUS_YEAR"
              # - "LAST_7_DAYS"
              # - "LAST_30_DAYS"
              # - "LAST_90_DAYS"
              # - "LAST_365_DAYS"
              # - "LAST_24_MONTHS"
          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
        },
        "dimensionFilters": [ # The list of filters dimensions are filtered on.
            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
          { # Represents a DimensionValue resource.
            "dimensionName": "A String", # Name of the dimension.
            "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
            "etag": "A String", # ETag of this response for caching purposes.
            "id": "A String", # The ID associated with the value if available.
            "value": "A String", # The value of the dimension.
          },
        ],
        "customRichMediaEvents": { # Custom Rich Media Events group.
          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
            { # Represents a DimensionValue resource.
              "dimensionName": "A String", # Name of the dimension.
              "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
              "etag": "A String", # ETag of this response for caching purposes.
              "id": "A String", # The ID associated with the value if available.
              "value": "A String", # The value of the dimension.
            },
          ],
        },
      },
      "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
      "type": "A String", # The type of the report, currently only "STANDARD" is supported.
      "id": "A String", # The unique ID identifying this report resource.
      "accountId": "A String", # The account id this report belongs to.
    }
run(profileId, reportId, synchronous=None)
Runs a report.

Args:
  profileId: string, The DFA profile id. (required)
  reportId: string, The id of the report. (required)
  synchronous: boolean, If set and true, tries to run the report synchronously.

Returns:
  An object of the form:

    { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
    "status": "A String", # The status of the report file, one of:
        # - "PROCESSING"
        # - "REPORT_AVAILABLE"
        # - "FAILED"
        # - "CANCELLED"
    "kind": "dfareporting#file", # Kind of resource this is, in this case dfareporting#file.
    "dateRange": { # The date range for which the file has report data.
      "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
      "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
    },
    "fileName": "A String", # The file name of the file.
    "etag": "A String", # ETag of this response for caching purposes.
    "reportId": "A String", # The ID of the report this file was generated from.
    "urls": { # The urls where the completed report file can be downloaded.
      "csv": { # Urls for generated CSV data.
        "browserUrl": "A String", # The url for downloading the report data through a browser.
        "apiUrl": "A String", # The url for downloading the report data through the API.
      },
    },
    "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
    "id": "A String", # The unique ID of this report file.
  }
update(profileId, reportId, body)
Updates a report.

Args:
  profileId: string, The DFA user profile id. (required)
  reportId: string, The id of the report. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Report resource.
    "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
    "name": "A String", # The name of the report.
    "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
      "startDate": "A String", # Start date of date range for which scheduled reports should be run.
      "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
          # - DAY_OF_MONTH
          # - WEEK_OF_MONTH
          # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
      "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
      "expirationDate": "A String", # The expiration date when the scheduled report stops running.
      "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
      "repeats": "A String", # The interval the report is repeated for, one of:
          # - "DAILY", also requires field "every" to be set.
          # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "TWICE_A_MONTH"
          # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
          # - "QUARTERLY"
          # - "YEARLY"
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
        "A String",
      ],
    },
    "ownerProfileId": "A String", # The user profile id of the owner of this report.
    "fileName": "A String", # The file name used when generating report files for this report.
    "etag": "A String", # ETag of this response for caching purposes.
    "criteria": { # The report criteria.
      "activities": { # Activity group.
        "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
          { # Represents a DimensionValue resource.
            "dimensionName": "A String", # Name of the dimension.
            "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
            "etag": "A String", # ETag of this response for caching purposes.
            "id": "A String", # The ID associated with the value if available.
            "value": "A String", # The value of the dimension.
          },
        ],
        "metricNames": [ # List of names of floodlight activity metrics.
          "A String",
        ],
      },
      "dimensions": [ # The list of dimensions the report should include.
        { # Represents a sorted dimension.
          "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
          "name": "A String", # The name of the dimension.
          "sortOrder": "A String", # An optional sort order for the dimension column, one of:
              # - "ASCENDING"
              # - "DESCENDING"
        },
      ],
      "metricNames": [ # The list of names of metrics the report should include.
        "A String",
      ],
      "dateRange": { # The date range this report should be run for.
        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
        "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
            # - "TODAY"
            # - "YESTERDAY"
            # - "WEEK_TO_DATE"
            # - "MONTH_TO_DATE"
            # - "QUARTER_TO_DATE"
            # - "YEAR_TO_DATE"
            # - "PREVIOUS_WEEK"
            # - "PREVIOUS_MONTH"
            # - "PREVIOUS_QUARTER"
            # - "PREVIOUS_YEAR"
            # - "LAST_7_DAYS"
            # - "LAST_30_DAYS"
            # - "LAST_90_DAYS"
            # - "LAST_365_DAYS"
            # - "LAST_24_MONTHS"
        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
      },
      "dimensionFilters": [ # The list of filters dimensions are filtered on.
          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
        { # Represents a DimensionValue resource.
          "dimensionName": "A String", # Name of the dimension.
          "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
          "etag": "A String", # ETag of this response for caching purposes.
          "id": "A String", # The ID associated with the value if available.
          "value": "A String", # The value of the dimension.
        },
      ],
      "customRichMediaEvents": { # Custom Rich Media Events group.
        "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
          { # Represents a DimensionValue resource.
            "dimensionName": "A String", # Name of the dimension.
            "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
            "etag": "A String", # ETag of this response for caching purposes.
            "id": "A String", # The ID associated with the value if available.
            "value": "A String", # The value of the dimension.
          },
        ],
      },
    },
    "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
    "type": "A String", # The type of the report, currently only "STANDARD" is supported.
    "id": "A String", # The unique ID identifying this report resource.
    "accountId": "A String", # The account id this report belongs to.
  }


Returns:
  An object of the form:

    { # Represents a Report resource.
      "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
      "name": "A String", # The name of the report.
      "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
        "startDate": "A String", # Start date of date range for which scheduled reports should be run.
        "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
            # - DAY_OF_MONTH
            # - WEEK_OF_MONTH
            # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
        "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
        "expirationDate": "A String", # The expiration date when the scheduled report stops running.
        "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
        "repeats": "A String", # The interval the report is repeated for, one of:
            # - "DAILY", also requires field "every" to be set.
            # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "TWICE_A_MONTH"
            # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
            # - "QUARTERLY"
            # - "YEARLY"
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
          "A String",
        ],
      },
      "ownerProfileId": "A String", # The user profile id of the owner of this report.
      "fileName": "A String", # The file name used when generating report files for this report.
      "etag": "A String", # ETag of this response for caching purposes.
      "criteria": { # The report criteria.
        "activities": { # Activity group.
          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
            { # Represents a DimensionValue resource.
              "dimensionName": "A String", # Name of the dimension.
              "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
              "etag": "A String", # ETag of this response for caching purposes.
              "id": "A String", # The ID associated with the value if available.
              "value": "A String", # The value of the dimension.
            },
          ],
          "metricNames": [ # List of names of floodlight activity metrics.
            "A String",
          ],
        },
        "dimensions": [ # The list of dimensions the report should include.
          { # Represents a sorted dimension.
            "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
            "name": "A String", # The name of the dimension.
            "sortOrder": "A String", # An optional sort order for the dimension column, one of:
                # - "ASCENDING"
                # - "DESCENDING"
          },
        ],
        "metricNames": [ # The list of names of metrics the report should include.
          "A String",
        ],
        "dateRange": { # The date range this report should be run for.
          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
          "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
              # - "TODAY"
              # - "YESTERDAY"
              # - "WEEK_TO_DATE"
              # - "MONTH_TO_DATE"
              # - "QUARTER_TO_DATE"
              # - "YEAR_TO_DATE"
              # - "PREVIOUS_WEEK"
              # - "PREVIOUS_MONTH"
              # - "PREVIOUS_QUARTER"
              # - "PREVIOUS_YEAR"
              # - "LAST_7_DAYS"
              # - "LAST_30_DAYS"
              # - "LAST_90_DAYS"
              # - "LAST_365_DAYS"
              # - "LAST_24_MONTHS"
          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
        },
        "dimensionFilters": [ # The list of filters dimensions are filtered on.
            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
          { # Represents a DimensionValue resource.
            "dimensionName": "A String", # Name of the dimension.
            "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
            "etag": "A String", # ETag of this response for caching purposes.
            "id": "A String", # The ID associated with the value if available.
            "value": "A String", # The value of the dimension.
          },
        ],
        "customRichMediaEvents": { # Custom Rich Media Events group.
          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
            { # Represents a DimensionValue resource.
              "dimensionName": "A String", # Name of the dimension.
              "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
              "etag": "A String", # ETag of this response for caching purposes.
              "id": "A String", # The ID associated with the value if available.
              "value": "A String", # The value of the dimension.
            },
          ],
        },
      },
      "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
      "type": "A String", # The type of the report, currently only "STANDARD" is supported.
      "id": "A String", # The unique ID identifying this report resource.
      "accountId": "A String", # The account id this report belongs to.
    }