REST Resource: networks.entitySignalsMappings

  • The EntitySignalsMapping resource represents a mapping between an entity and associated taxonomy categories.

  • An EntitySignalsMapping can be associated with an Audience Segment, Content Bundle, or Custom Targeting Value.

  • The resource includes fields such as name, taxonomyCategoryIds, and an identifier for the associated entity.

  • Methods available for EntitySignalsMapping include creating, retrieving, updating, and listing these objects, including batch operations.

Resource: EntitySignalsMapping

The EntitySignalsMapping resource.

JSON representation
{
  "name": string,
  "taxonomyCategoryIds": [
    string
  ],
  "taxonomyCategories": [
    string
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "audienceSegmentId": string,
  "contentBundleId": string,
  "customTargetingValueId": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "audienceSegment": string,
  "contentBundle": string,
  "customTargetingValue": string
  // End of mutually exclusive fields.
  "entitySignalsMappingId": string
}
Fields
name

string

Identifier. The resource name of the EntitySignalsMapping. Format: networks/{networkCode}/entitySignalsMappings/{entitySignalsMappingId}

taxonomyCategoryIds[]
(deprecated)

string (int64 format)

Optional. Deprecated: The IDs of the categories that are associated with the referencing entity.

taxonomyCategories[]

string

Optional. The resource names of the TaxonomyCategory that are associated with the referencing entity. Format: networks/{networkCode}/taxonomyCategories/{taxonomyCategoryId}

The ID of the entity that the mapping belongs to. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
audienceSegmentId
(deprecated)

string (int64 format)

Deprecated: ID of an AudienceSegment that this mapping belongs to.

contentBundleId
(deprecated)

string (int64 format)

Deprecated: ID of a ContentBundle that this mapping belongs to.

customTargetingValueId
(deprecated)

string (int64 format)

Deprecated: ID of a CustomTargetingValue that this mapping belongs to.

End of mutually exclusive fields.
The entity that the mapping belongs to. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
audienceSegment

string

The resource name of an AudienceSegment that this mapping belongs to. Format: networks/{networkCode}/audienceSegments/{audienceSegmentId}

contentBundle

string

The resource name of a ContentBundle that this mapping belongs to. Format: networks/{networkCode}/contentBundles/{contentBundleId}

customTargetingValue

string

The resource name of a CustomTargetingValue that this mapping belongs to. Format: networks/{networkCode}/customTargetingValues/{customTargetingValueId}

End of mutually exclusive fields.
entitySignalsMappingId
(deprecated)

string (int64 format)

Output only. Deprecated: EntitySignalsMapping ID.

Methods

batchCreate

Creates EntitySignalsMapping objects.

batchUpdate

Batch updates EntitySignalsMapping objects.

create

Creates an EntitySignalsMapping object.

get

Retrieves a EntitySignalsMapping object.

list

Lists EntitySignalsMapping objects.

patch

Updates an EntitySignalsMapping object.