google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
75 lines (74 loc) • 3.04 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 { KeywordMatchTypeEnum_KeywordMatchType } from "../enums/keyword_match_type";
/**
* A Keyword Plan ad group keyword.
* Max number of keyword plan keywords per plan: 10000.
*
* @generated from protobuf message google.ads.googleads.v11.resources.KeywordPlanAdGroupKeyword
*/
export interface KeywordPlanAdGroupKeyword {
/**
* Immutable. The resource name of the Keyword Plan ad group keyword.
* KeywordPlanAdGroupKeyword resource names have the form:
*
* `customers/{customer_id}/keywordPlanAdGroupKeywords/{kp_ad_group_keyword_id}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The Keyword Plan ad group to which this keyword belongs.
*
* @generated from protobuf field: optional string keyword_plan_ad_group = 8;
*/
keywordPlanAdGroup?: string;
/**
* Output only. The ID of the Keyword Plan keyword.
*
* @generated from protobuf field: optional int64 id = 9;
*/
id?: bigint;
/**
* The keyword text.
*
* @generated from protobuf field: optional string text = 10;
*/
text?: string;
/**
* The keyword match type.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5;
*/
matchType: KeywordMatchTypeEnum_KeywordMatchType;
/**
* A keyword level max cpc bid in micros (for example, $1 = 1mm). The currency
* is the same as the account currency code. This will override any CPC bid
* set at the keyword plan ad group level. Not applicable for negative
* keywords. (negative = true) This field is Optional.
*
* @generated from protobuf field: optional int64 cpc_bid_micros = 11;
*/
cpcBidMicros?: bigint;
/**
* Immutable. If true, the keyword is negative.
*
* @generated from protobuf field: optional bool negative = 12;
*/
negative?: boolean;
}
declare class KeywordPlanAdGroupKeyword$Type extends MessageType<KeywordPlanAdGroupKeyword> {
constructor();
create(value?: PartialMessage<KeywordPlanAdGroupKeyword>): KeywordPlanAdGroupKeyword;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: KeywordPlanAdGroupKeyword): KeywordPlanAdGroupKeyword;
internalBinaryWrite(message: KeywordPlanAdGroupKeyword, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.KeywordPlanAdGroupKeyword
*/
export declare const KeywordPlanAdGroupKeyword: KeywordPlanAdGroupKeyword$Type;
export {};