REST Resource: buyers.dataSegments

  • A DataSegment defines an identifier for a segment of inventory that can be targeted in deals or auction packages.

  • Key fields of a DataSegment include its unique identifier (name), creation and update times, a required CPM fee, and its state.

  • The state of a DataSegment can be either ACTIVE or INACTIVE.

  • Methods are available to activate, create, deactivate, get, list, and patch data segments.

Resource: DataSegment

Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "cpmFee": {
    object (Money)
  },
  "state": enum (State)
}
Fields
name

string

Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: buyers/{accountId}/dataSegments/{curatorDataSegmentId} v1beta format: curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}
createTime

string (Timestamp format)

Output only. Time the data segment was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Time the data segment was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
cpmFee

object (Money)

Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed.
state

enum (State)

Output only. The state of the data segment.

State

Output only. Use the activate and deactivate method to change state.

Enums
STATE_UNSPECIFIED Default value.
ACTIVE The data segment is active.
INACTIVE The data segment is inactive.

Methods

activate

 Activates a data segment.

create

 Creates a data segment owned by the listed curator.

deactivate

 Deactivates a data segment.

get

 Gets a data segment given its name.

list

 List the data segments owned by a curator.

patch

 Updates a data segment.