tags_add: Add a tag to a component

View source: R/tag_add.R

tags_addR Documentation

Add a tag to a component

Description

Enables the creation of a new tag and applies the new tag to the passed component

Usage

tags_add(
  company_id = Sys.getenv("AW_COMPANY_ID"),
  componentId = NULL,
  componentType = NULL,
  tagNames = NULL,
  overwrite = FALSE,
  debug = FALSE
)

Arguments

company_id

Company ID. If an environment variable called AW_COMPANY_ID exists in .Renviron or elsewhere and no company_id argument is provided, then the AW_COMPANY_ID value will be used. Use get_me to get a list of available company_id values.

componentId

The component id being requested. Default is NULL

componentType

The component type being requested. Options include segment, dashboard, bookmark, calculatedMetric, project, dateRange, metric, dimension, virtualReportSuite, scheduledJob, alert, classification. Default is NULL

tagNames

Comma separated vector of tag names.

overwrite

Overwrite the existing tag names on a component. To append a new tag name use FALSE (default). To overwrite the existing tags on a component use TRUE.

debug

Include the output and input of the api call in the console for debugging. Default is FALSE

Value

A data frame of segments and their meta data.


adobeanalyticsr documentation built on Nov. 9, 2023, 5:07 p.m.