google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
93 lines (92 loc) • 3.84 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";
/**
* A category generated automatically by crawling a domain. If a campaign uses
* the DynamicSearchAdsSetting, then domain categories will be generated for
* the domain. The categories can be targeted using WebpageConditionInfo.
* See: https://support.google.com/google-ads/answer/2471185
*
* @generated from protobuf message google.ads.googleads.v11.resources.DomainCategory
*/
export interface DomainCategory {
/**
* Output only. The resource name of the domain category.
* Domain category resource names have the form:
*
* `customers/{customer_id}/domainCategories/{campaign_id}~{category_base64}~{language_code}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Output only. The campaign this category is recommended for.
*
* @generated from protobuf field: optional string campaign = 10;
*/
campaign?: string;
/**
* Output only. Recommended category for the website domain, for example, if you have a
* website about electronics, the categories could be "cameras",
* "televisions", etc.
*
* @generated from protobuf field: optional string category = 11;
*/
category?: string;
/**
* Output only. The language code specifying the language of the website, for example, "en"
* for English. The language can be specified in the DynamicSearchAdsSetting
* required for dynamic search ads. This is the language of the pages from
* your website that you want Google Ads to find, create ads for,
* and match searches with.
*
* @generated from protobuf field: optional string language_code = 12;
*/
languageCode?: string;
/**
* Output only. The domain for the website. The domain can be specified in the
* DynamicSearchAdsSetting required for dynamic search ads.
*
* @generated from protobuf field: optional string domain = 13;
*/
domain?: string;
/**
* Output only. Fraction of pages on your site that this category matches.
*
* @generated from protobuf field: optional double coverage_fraction = 14;
*/
coverageFraction?: number;
/**
* Output only. The position of this category in the set of categories. Lower numbers
* indicate a better match for the domain. null indicates not recommended.
*
* @generated from protobuf field: optional int64 category_rank = 15;
*/
categoryRank?: bigint;
/**
* Output only. Indicates whether this category has sub-categories.
*
* @generated from protobuf field: optional bool has_children = 16;
*/
hasChildren?: boolean;
/**
* Output only. The recommended cost per click for the category.
*
* @generated from protobuf field: optional int64 recommended_cpc_bid_micros = 17;
*/
recommendedCpcBidMicros?: bigint;
}
declare class DomainCategory$Type extends MessageType<DomainCategory> {
constructor();
create(value?: PartialMessage<DomainCategory>): DomainCategory;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: DomainCategory): DomainCategory;
internalBinaryWrite(message: DomainCategory, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.DomainCategory
*/
export declare const DomainCategory: DomainCategory$Type;
export {};