google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
76 lines (75 loc) • 3.4 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";
import { ConversionCustomVariableStatusEnum_ConversionCustomVariableStatus } from "../enums/conversion_custom_variable_status";
/**
* A conversion custom variable
* See "About custom variables for conversions" at
* https://support.google.com/google-ads/answer/9964350
*
* @generated from protobuf message google.ads.googleads.v11.resources.ConversionCustomVariable
*/
export interface ConversionCustomVariable {
/**
* Immutable. The resource name of the conversion custom variable.
* Conversion custom variable resource names have the form:
*
* `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Output only. The ID of the conversion custom variable.
*
* @generated from protobuf field: int64 id = 2;
*/
id: bigint;
/**
* Required. The name of the conversion custom variable.
* Name should be unique. The maximum length of name is 100 characters.
* There should not be any extra spaces before and after.
*
* @generated from protobuf field: string name = 3;
*/
name: string;
/**
* Required. Immutable. The tag of the conversion custom variable. It is used in the event snippet
* and sent to Google Ads along with conversion pings. For conversion uploads
* in Google Ads API, the resource name of the conversion custom variable is
* used.
* Tag should be unique. The maximum size of tag is 100 bytes.
* There should not be any extra spaces before and after.
* Currently only lowercase letters, numbers and underscores are allowed in
* the tag.
*
* @generated from protobuf field: string tag = 4;
*/
tag: string;
/**
* The status of the conversion custom variable for conversion event accrual.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5;
*/
status: ConversionCustomVariableStatusEnum_ConversionCustomVariableStatus;
/**
* Output only. The resource name of the customer that owns the conversion custom variable.
*
* @generated from protobuf field: string owner_customer = 6;
*/
ownerCustomer: string;
}
declare class ConversionCustomVariable$Type extends MessageType<ConversionCustomVariable> {
constructor();
create(value?: PartialMessage<ConversionCustomVariable>): ConversionCustomVariable;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ConversionCustomVariable): ConversionCustomVariable;
internalBinaryWrite(message: ConversionCustomVariable, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.ConversionCustomVariable
*/
export declare const ConversionCustomVariable: ConversionCustomVariable$Type;
export {};