google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
69 lines (68 loc) • 3.03 kB
TypeScript
import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
import type { IBinaryWriter } from "@protobuf-ts/runtime";
import type { BinaryReadOptions } from "@protobuf-ts/runtime";
import type { IBinaryReader } from "@protobuf-ts/runtime";
import type { PartialMessage } from "@protobuf-ts/runtime";
import { MessageType } from "@protobuf-ts/runtime";
/**
* An ad parameter that is used to update numeric values (such as prices or
* inventory levels) in any text line of an ad (including URLs). There can
* be a maximum of two AdParameters per ad group criterion. (One with
* parameter_index = 1 and one with parameter_index = 2.)
* In the ad the parameters are referenced by a placeholder of the form
* "{param#:value}". For example, "{param1:$17}"
*
* @generated from protobuf message google.ads.googleads.v11.resources.AdParameter
*/
export interface AdParameter {
/**
* Immutable. The resource name of the ad parameter.
* Ad parameter resource names have the form:
*
* `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Immutable. The ad group criterion that this ad parameter belongs to.
*
* @generated from protobuf field: optional string ad_group_criterion = 5;
*/
adGroupCriterion?: string;
/**
* Immutable. The unique index of this ad parameter. Must be either 1 or 2.
*
* @generated from protobuf field: optional int64 parameter_index = 6;
*/
parameterIndex?: bigint;
/**
* Numeric value to insert into the ad text. The following restrictions
* apply:
* - Can use comma or period as a separator, with an optional period or
* comma (respectively) for fractional values. For example, 1,000,000.00
* and 2.000.000,10 are valid.
* - Can be prepended or appended with a currency symbol. For example,
* $99.99 is valid.
* - Can be prepended or appended with a currency code. For example, 99.99USD
* and EUR200 are valid.
* - Can use '%'. For example, 1.0% and 1,0% are valid.
* - Can use plus or minus. For example, -10.99 and 25+ are valid.
* - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are
* valid.
*
* @generated from protobuf field: optional string insertion_text = 7;
*/
insertionText?: string;
}
declare class AdParameter$Type extends MessageType<AdParameter> {
constructor();
create(value?: PartialMessage<AdParameter>): AdParameter;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AdParameter): AdParameter;
internalBinaryWrite(message: AdParameter, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.AdParameter
*/
export declare const AdParameter: AdParameter$Type;
export {};