ProductCustomLabel
Contiene los métodos para administrar un grupo de productos de etiqueta personalizado. Este objeto deriva de ProductGroup.
Utilizado por el motor de entrega para determinar si se sirve un producto del catálogo del anunciante. El motor puede servir al producto si la etiqueta personalizada del producto coincide exactamente con la etiqueta devuelta porgetType.
Ejemplo de uso:
var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get().next();
var productGroups = shoppingCampaign.productGroups().get();
while (productGroups.hasNext()) {
var group = productGroups.next();
switch (group.getDimension()) {
case "CUSTOM_LABEL": {
// It's only necessary to cast the product group to a ProductCustomLabel product
// group if you need to get the label's name by calling getType(). Otherwise,
// you can simply use ProductGroup if you want to get the label's value by
// calling getValue().
var customLabel = productGroup.asCustomLabel();
var labelName = customLabel.getType();
var labelValue = customLabel.getValue();
break;
}
// Other cases
}
}
Métodos
Nombre del método | Tipo de valor devuelto | Descripción |
---|---|---|
secundario | ProductGroupSelector | Obtiene un selector que se usa para filtrar la lista de grupos de productos secundarios de este grupo de productos. |
getAdGroup | Adgroup | Obtiene el grupo de anuncios al que pertenece este grupo de productos. |
getCampaign | Campaña | Obtiene la campaña a la que pertenece este grupo de productos. |
getDimension | string | Obtiene la dimensión de este grupo de productos. |
getEntityType | string | Obtiene el tipo de esta entidad. |
getId | string | Obtiene el identificador que identifica de forma única este grupo de productos. |
getMaxCpc | double | Obtiene el importe máximo de la puja de costo por clic para este grupo de productos. |
getStats | Estadísticas | Obtiene los datos de rendimiento de este grupo de productos. |
Gettype | string | Obtiene el tipo de etiqueta personalizado del producto. |
Getvalue | string | Obtiene el valor de la etiqueta personalizada. |
isExcluded | Booleano | Obtiene un valor booleano que determina si se excluye este grupo de productos. |
isOtherCase | Booleano | Obtiene un valor booleano que determina si este grupo de productos representa todos los demás casos no representados por su grupo de productos del mismo nivel. |
primario | ProductGroup | Obtiene el grupo de productos primario de este grupo de productos. |
setMaxCpc(double cpc) | void | Establece el importe máximo de puja de costo por clic que se usará para este grupo de productos. |
secundario
Obtiene un selector que se usa para filtrar la lista de grupos de productos secundarios de este grupo de productos.
Valores devueltos
Tipo | Descripción |
---|---|
ProductGroupSelector | Selector que se usa para filtrar la lista de elementos secundarios de este grupo de productos. |
getAdGroup
Obtiene el grupo de anuncios al que pertenece este grupo de productos.
Valores devueltos
Tipo | Descripción |
---|---|
Adgroup | Grupo de anuncios al que pertenece este grupo de productos. |
getCampaign
Obtiene la campaña a la que pertenece este grupo de productos.
Valores devueltos
Tipo | Descripción |
---|---|
Campaña | Campaña a la que pertenece este grupo de productos. |
getDimension
Obtiene la dimensión de este grupo de productos.
Valores devueltos
Tipo | Descripción |
---|---|
Cadena | Dimensión de este grupo de productos, que se establece en CUSTOM_LABEL. |
getEntityType
Obtiene el tipo de esta entidad.
Valores devueltos
Tipo | Descripción |
---|---|
string | Tipo de esta entidad, que es ProductCustomLabel. |
getId
Obtiene el identificador que identifica de forma única este grupo de productos.
Valores devueltos
Tipo | Descripción |
---|---|
string | Identificador que identifica de forma única este grupo de productos. |
getMaxCpc
Obtiene el importe máximo de la oferta de costo por clic de este grupo de productos.
Valores devueltos
Tipo | Descripción |
---|---|
double | El importe de la oferta. Devuelve null si no se establece o se trata de un grupo de productos negativo (isExluded es true). |
getStats
Obtiene los datos de rendimiento de este grupo de productos.
Para llamar a este método, debe incluir uno de los forDateRange
métodos en la cadena del selector del grupo de productos.
Valores devueltos:
Tipo | Descripción |
---|---|
Estadísticas | Los datos de rendimiento de este grupo de productos. |
Gettype
Obtiene el tipo de etiqueta personalizado del producto.
Valores devueltos
Tipo | Descripción |
---|---|
Cadena | Tipo de etiqueta personalizada del producto. Por ejemplo, CustomLabel0 a CustomLabel4. |
Getvalue
Obtiene el valor de la etiqueta personalizada.
Valores devueltos:
Tipo | Descripción |
---|---|
string | Valor de la etiqueta personalizada. |
isExcluded
Obtiene un valor booleano que determina si este grupo de productos es un grupo de productos negativo.
Valores devueltos:
Tipo | Descripción |
---|---|
Booleano | Es true si este grupo de productos es un grupo negativo; De lo contrario, false. Por ejemplo, en lugar de incluir todos los esquís de descenso, los excluirá. |
isOtherCase
Obtiene un valor booleano que determina si este grupo de productos representa todo lo demás no representado por su grupo de productos del mismo nivel (es decir, el otro caso).
Valores devueltos:
Tipo | Descripción |
---|---|
Booleano | Es true si este grupo de productos representa el caso "otro"; De lo contrario, false. Por ejemplo, si divide Todos los productos (el nodo raíz) por Sporting Goods, el servicio crea un grupo de productos del mismo nivel que representa los productos que no están en Sporting Goods y establece este campo en true. El identificador primario de este grupo de productos y el grupo de productos Sporting Goods apuntan al nodo raíz. |
primario
Obtiene el elemento primario de este grupo de productos.
Valores devueltos:
Tipo | Descripción |
---|---|
ProductGroup | El elemento primario de este grupo de productos. |
setMaxCpc(double cpc)
Establece el importe máximo de la puja de costo por clic para este grupo de productos.
Argumentos
Nombre | Tipo | Descripción |
---|---|---|
Cpc | double | El importe de la oferta. El importe de la puja se encuentra en la moneda de la cuenta, que determina los valores de puja mínimos y máximos que puede especificar. No establezca la oferta si este grupo de productos está subdividido (tiene elementos secundarios) o es un grupo de productos negativo (isExcluded es true). |
Valores devueltos
Tipo | Descripción |
---|---|
void | Devuelve el valor nothing. |