Method: customers.describeValidFrequencyLimitingEventMatchers

Lists valid event matchers along with their metadata for frequency capping audience lists. Each event matcher has metadata that includes, for example, an owning AdsDataLink.Entity and a name for the corresponding campaign or line item.

HTTP request

GET https://adsdatahub.googleapis.com/v1/{customer=customers/*}:describeValidFrequencyLimitingEventMatchers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customer

string

Customer resource name, e.g. 'customers/123'.

Query parameters

Parameters
adsDataCustomerId

string (int64 format)

Ads Data Owning customer's ID, e.g. 456.

pageSize

integer

Maximum number of items to return. If 0, the server will determine the number of linked customers to return.

pageToken

string

Page token, returned by a previous call, used to request the next page of results, if any.

filter

string

Restrict which event matchers are returned. Accepts filters on all the sub-fields of eventMatcher, eventMatcherMetadata.entity, and eventMatcherMetadata.parent_event_matcher. Example filters: eventMatcher.value = 1234 eventMatcher.match_type = DV360_LINE_ITEM_ID OR eventMatcher.match_type = DV360_INSERTION_ORDER_ID eventMatcherMetadata.display_name = "Campaign 456" eventMatcherMetadata.entity.entity_id = 5678 eventMatcherMetadata.entity.display_name = "Customer 123" eventMatcherMetadata.entity.type = GMP_DV360_ADVERTISER eventMatcherMetadata.parent_event_matcher.value = 6789 eventMatcherMetadata.parent_event_matcher.match_type = DV360_INSERTION_ORDER_ID

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response to a DescribeValidFrequencyLimitingEventMatchersRequest request.

JSON representation
{
  "eventMatcherInfos": [
    {
      object (EventMatcherInfo)
    }
  ],
  "nextPageToken": string
}
Fields
eventMatcherInfos[]

object (EventMatcherInfo)

List of units, each containing an event matcher along with its metadata

nextPageToken

string

A token that can be used to request the next results page. This field is empty if there are no additional results.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub

EventMatcherInfo

Event matcher along with its metadata.

JSON representation
{
  "eventMatcher": {
    object (EventMatcher)
  },
  "eventMatcherMetadata": {
    object (EventMatcherMetadata)
  }
}
Fields
eventMatcher

object (EventMatcher)

Event matcher containing the constraint type and valid constraint ID.

eventMatcherMetadata

object (EventMatcherMetadata)

Metadata for the event matcher.

EventMatcherMetadata

Metadata for the event matcher.

JSON representation
{
  "entity": {
    object (Entity)
  },
  "displayName": string,
  "parentEventMatcher": {
    object (EventMatcher)
  }
}
Fields
entity

object (Entity)

Linked entity from AdsDataLink.

displayName

string

Name in the underlying data store for the constraint. This could be a campaign name, a line item name etc.

parentEventMatcher

object (EventMatcher)

Related parent EventMatcher, if any. If eventMatcher is a DV360 line item, this field will refer to the EventMatcher for the corresponding DV360 insertion order that the line item is part of.