google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
98 lines (97 loc) • 3.72 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 { KeywordInfo } from "../common/criteria";
import { ClickLocation } from "../common/click_location";
/**
* A click view with metrics aggregated at each click level, including both
* valid and invalid clicks. For non-Search campaigns, metrics.clicks
* represents the number of valid and invalid interactions.
* Queries including ClickView must have a filter limiting the results to one
* day and can be requested for dates back to 90 days before the time of the
* request.
*
* @generated from protobuf message google.ads.googleads.v11.resources.ClickView
*/
export interface ClickView {
/**
* Output only. The resource name of the click view.
* Click view resource names have the form:
*
* `customers/{customer_id}/clickViews/{date (yyyy-MM-dd)}~{gclid}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Output only. The Google Click ID.
*
* @generated from protobuf field: optional string gclid = 8;
*/
gclid?: string;
/**
* Output only. The location criteria matching the area of interest associated with the
* impression.
*
* @generated from protobuf field: google.ads.googleads.v11.common.ClickLocation area_of_interest = 3;
*/
areaOfInterest?: ClickLocation;
/**
* Output only. The location criteria matching the location of presence associated with the
* impression.
*
* @generated from protobuf field: google.ads.googleads.v11.common.ClickLocation location_of_presence = 4;
*/
locationOfPresence?: ClickLocation;
/**
* Output only. Page number in search results where the ad was shown.
*
* @generated from protobuf field: optional int64 page_number = 9;
*/
pageNumber?: bigint;
/**
* Output only. The associated ad.
*
* @generated from protobuf field: optional string ad_group_ad = 10;
*/
adGroupAd?: string;
/**
* Output only. The associated campaign location target, if one exists.
*
* @generated from protobuf field: optional string campaign_location_target = 11;
*/
campaignLocationTarget?: string;
/**
* Output only. The associated user list, if one exists.
*
* @generated from protobuf field: optional string user_list = 12;
*/
userList?: string;
/**
* Output only. The associated keyword, if one exists and the click corresponds to the
* SEARCH channel.
*
* @generated from protobuf field: string keyword = 13;
*/
keyword: string;
/**
* Output only. Basic information about the associated keyword, if it exists.
*
* @generated from protobuf field: google.ads.googleads.v11.common.KeywordInfo keyword_info = 14;
*/
keywordInfo?: KeywordInfo;
}
declare class ClickView$Type extends MessageType<ClickView> {
constructor();
create(value?: PartialMessage<ClickView>): ClickView;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ClickView): ClickView;
internalBinaryWrite(message: ClickView, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.ClickView
*/
export declare const ClickView: ClickView$Type;
export {};