Sign in
curators

Updates a data segment.

patch/v1/{+name}

Request

  • Base URL: https://curationpartners.googleapis.com
  • URL: https://curationpartners.googleapis.com/v1/{+name}
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/curation-partners) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/curation-partners)

Path parameters

namestring required

Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}

Query parameters

updateMaskstring

Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.

Request body

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'INACTIVE' | 'SUSPENDED'

Output only. The state of the data segment.

namestring

Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}

createTimestring google-datetime

Output only. Time the data segment was created.

updateTimestring google-datetime

Output only. Time the data segment was last updated.

millipercentOfMediaFeestring int64

Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000.

userListIdstring

Optional. Immutable. The ID of the User List wrapped by this Data Segment. Curators with a linked Data Partner account can create a data segment that wraps a user list owned by the linked Data Partner account. User lists can be uploaded and managed using the Data Manager API. Linking a user list to a data segment lets you define a segment of inventory that is based on an audience you create.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.