DCM/DFA Reporting And Trafficking API . 4 . dimensionValues

Instance Methods

query(profileId=*, body=None, pageToken=None, maxResults=None)

Retrieves list of report dimension values for a list of filters.

query_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

Method Details

query(profileId=*, body=None, pageToken=None, maxResults=None)
Retrieves list of report dimension values for a list of filters.

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

{ # Represents a DimensionValuesRequest.
    "dimensionName": "A String", # The name of the dimension for which values should be requested.
    "startDate": "A String", # The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd".
    "kind": "dfareporting#dimensionValueRequest", # The kind of request this is, in this case dfareporting#dimensionValueRequest.
    "endDate": "A String", # The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd".
    "filters": [ # The list of filters by which to filter values. The filters are ANDed.
      { # Represents a dimension filter.
        "dimensionName": "A String", # The name of the dimension to filter.
        "kind": "dfareporting#dimensionFilter", # The kind of resource this is, in this case dfareporting#dimensionFilter.
        "value": "A String", # The value of the dimension to filter.
      },
    ],
  }

  pageToken: string, The value of the nextToken from the previous result page.
  maxResults: integer, Maximum number of results to return.

Returns:
  An object of the form:

    { # Represents the list of DimensionValue resources.
    "nextPageToken": "A String", # Continuation token used to page through dimension values. 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 dimension values returned in this response.
      { # Represents a DimensionValue resource.
        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "value": "A String", # The value of the dimension.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "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.
        "id": "A String", # The ID associated with the value if available.
      },
    ],
    "kind": "dfareporting#dimensionValueList", # The kind of list this is, in this case dfareporting#dimensionValueList.
    "etag": "A String", # The eTag of this response for caching purposes.
  }
query_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.