google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
293 lines (292 loc) • 12.7 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 { ConversionTrackingStatusEnum_ConversionTrackingStatus } from "../enums/conversion_tracking_status_enum";
import { CustomerStatusEnum_CustomerStatus } from "../enums/customer_status";
import { CustomerPayPerConversionEligibilityFailureReasonEnum_CustomerPayPerConversionEligibilityFailureReason } from "../enums/customer_pay_per_conversion_eligibility_failure_reason";
/**
* A customer.
*
* @generated from protobuf message google.ads.googleads.v11.resources.Customer
*/
export interface Customer {
/**
* Immutable. The resource name of the customer.
* Customer resource names have the form:
*
* `customers/{customer_id}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Output only. The ID of the customer.
*
* @generated from protobuf field: optional int64 id = 19;
*/
id?: bigint;
/**
* Optional, non-unique descriptive name of the customer.
*
* @generated from protobuf field: optional string descriptive_name = 20;
*/
descriptiveName?: string;
/**
* Immutable. The currency in which the account operates.
* A subset of the currency codes from the ISO 4217 standard is
* supported.
*
* @generated from protobuf field: optional string currency_code = 21;
*/
currencyCode?: string;
/**
* Immutable. The local timezone ID of the customer.
*
* @generated from protobuf field: optional string time_zone = 22;
*/
timeZone?: string;
/**
* The URL template for constructing a tracking URL out of parameters.
*
* @generated from protobuf field: optional string tracking_url_template = 23;
*/
trackingUrlTemplate?: string;
/**
* The URL template for appending params to the final URL
*
* @generated from protobuf field: optional string final_url_suffix = 24;
*/
finalUrlSuffix?: string;
/**
* Whether auto-tagging is enabled for the customer.
*
* @generated from protobuf field: optional bool auto_tagging_enabled = 25;
*/
autoTaggingEnabled?: boolean;
/**
* Output only. Whether the Customer has a Partners program badge. If the Customer is not
* associated with the Partners program, this will be false. For more
* information, see https://support.google.com/partners/answer/3125774.
*
* @generated from protobuf field: optional bool has_partners_badge = 26;
*/
hasPartnersBadge?: boolean;
/**
* Output only. Whether the customer is a manager.
*
* @generated from protobuf field: optional bool manager = 27;
*/
manager?: boolean;
/**
* Output only. Whether the customer is a test account.
*
* @generated from protobuf field: optional bool test_account = 28;
*/
testAccount?: boolean;
/**
* Call reporting setting for a customer. Only mutable in an `update`
* operation.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CallReportingSetting call_reporting_setting = 10;
*/
callReportingSetting?: CallReportingSetting;
/**
* Output only. Conversion tracking setting for a customer.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.ConversionTrackingSetting conversion_tracking_setting = 14;
*/
conversionTrackingSetting?: ConversionTrackingSetting;
/**
* Output only. Remarketing setting for a customer.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.RemarketingSetting remarketing_setting = 15;
*/
remarketingSetting?: RemarketingSetting;
/**
* Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If
* the list is empty, the customer is eligible. This field is read-only.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16;
*/
payPerConversionEligibilityFailureReasons: CustomerPayPerConversionEligibilityFailureReasonEnum_CustomerPayPerConversionEligibilityFailureReason[];
/**
* Output only. Optimization score of the customer.
*
* Optimization score is an estimate of how well a customer's campaigns are
* set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null
* for all manager customers, and for unscored non-manager customers.
*
* See "About optimization score" at
* https://support.google.com/google-ads/answer/9061546.
*
* This field is read-only.
*
* @generated from protobuf field: optional double optimization_score = 29;
*/
optimizationScore?: number;
/**
* Output only. Optimization score weight of the customer.
*
* Optimization score weight can be used to compare/aggregate optimization
* scores across multiple non-manager customers. The aggregate optimization
* score of a manager is computed as the sum over all of their customers of
* `Customer.optimization_score * Customer.optimization_score_weight`. This
* field is 0 for all manager customers, and for unscored non-manager
* customers.
*
* This field is read-only.
*
* @generated from protobuf field: double optimization_score_weight = 30;
*/
optimizationScoreWeight: number;
/**
* Output only. The status of the customer.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.CustomerStatusEnum.CustomerStatus status = 36;
*/
status: CustomerStatusEnum_CustomerStatus;
}
/**
* Call reporting setting for a customer. Only mutable in an `update` operation.
*
* @generated from protobuf message google.ads.googleads.v11.resources.CallReportingSetting
*/
export interface CallReportingSetting {
/**
* Enable reporting of phone call events by redirecting them through Google
* System.
*
* @generated from protobuf field: optional bool call_reporting_enabled = 10;
*/
callReportingEnabled?: boolean;
/**
* Whether to enable call conversion reporting.
*
* @generated from protobuf field: optional bool call_conversion_reporting_enabled = 11;
*/
callConversionReportingEnabled?: boolean;
/**
* Customer-level call conversion action to attribute a call conversion to.
* If not set a default conversion action is used. Only in effect when
* call_conversion_reporting_enabled is set to true.
*
* @generated from protobuf field: optional string call_conversion_action = 12;
*/
callConversionAction?: string;
}
/**
* A collection of customer-wide settings related to Google Ads Conversion
* Tracking.
*
* @generated from protobuf message google.ads.googleads.v11.resources.ConversionTrackingSetting
*/
export interface ConversionTrackingSetting {
/**
* Output only. The conversion tracking id used for this account. This id doesn't indicate
* whether the customer uses conversion tracking (conversion_tracking_status
* does). This field is read-only.
*
* @generated from protobuf field: optional int64 conversion_tracking_id = 3;
*/
conversionTrackingId?: bigint;
/**
* Output only. The conversion tracking id of the customer's manager. This is set when the
* customer is opted into cross account conversion tracking, and it overrides
* conversion_tracking_id. This field can only be managed through the Google
* Ads UI. This field is read-only.
*
* @generated from protobuf field: optional int64 cross_account_conversion_tracking_id = 4;
*/
crossAccountConversionTrackingId?: bigint;
/**
* Output only. Whether the customer has accepted customer data terms. If using
* cross-account conversion tracking, this value is inherited from the
* manager. This field is read-only. For more
* information, see https://support.google.com/adspolicy/answer/7475709.
*
* @generated from protobuf field: bool accepted_customer_data_terms = 5;
*/
acceptedCustomerDataTerms: boolean;
/**
* Output only. Conversion tracking status. It indicates whether the customer is using
* conversion tracking, and who is the conversion tracking owner of this
* customer. If this customer is using cross-account conversion tracking,
* the value returned will differ based on the `login-customer-id` of the
* request.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.ConversionTrackingStatusEnum.ConversionTrackingStatus conversion_tracking_status = 6;
*/
conversionTrackingStatus: ConversionTrackingStatusEnum_ConversionTrackingStatus;
/**
* Output only. Whether the customer is opted-in for enhanced conversions
* for leads. If using cross-account conversion tracking, this value is
* inherited from the manager. This field is read-only.
*
* @generated from protobuf field: bool enhanced_conversions_for_leads_enabled = 7;
*/
enhancedConversionsForLeadsEnabled: boolean;
/**
* Output only. The resource name of the customer where conversions are created and
* managed. This field is read-only.
*
* @generated from protobuf field: string google_ads_conversion_customer = 8;
*/
googleAdsConversionCustomer: string;
}
/**
* Remarketing setting for a customer.
*
* @generated from protobuf message google.ads.googleads.v11.resources.RemarketingSetting
*/
export interface RemarketingSetting {
/**
* Output only. The Google tag.
*
* @generated from protobuf field: optional string google_global_site_tag = 2;
*/
googleGlobalSiteTag?: string;
}
declare class Customer$Type extends MessageType<Customer> {
constructor();
create(value?: PartialMessage<Customer>): Customer;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Customer): Customer;
internalBinaryWrite(message: Customer, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.Customer
*/
export declare const Customer: Customer$Type;
declare class CallReportingSetting$Type extends MessageType<CallReportingSetting> {
constructor();
create(value?: PartialMessage<CallReportingSetting>): CallReportingSetting;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CallReportingSetting): CallReportingSetting;
internalBinaryWrite(message: CallReportingSetting, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.CallReportingSetting
*/
export declare const CallReportingSetting: CallReportingSetting$Type;
declare class ConversionTrackingSetting$Type extends MessageType<ConversionTrackingSetting> {
constructor();
create(value?: PartialMessage<ConversionTrackingSetting>): ConversionTrackingSetting;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ConversionTrackingSetting): ConversionTrackingSetting;
internalBinaryWrite(message: ConversionTrackingSetting, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.ConversionTrackingSetting
*/
export declare const ConversionTrackingSetting: ConversionTrackingSetting$Type;
declare class RemarketingSetting$Type extends MessageType<RemarketingSetting> {
constructor();
create(value?: PartialMessage<RemarketingSetting>): RemarketingSetting;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: RemarketingSetting): RemarketingSetting;
internalBinaryWrite(message: RemarketingSetting, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.RemarketingSetting
*/
export declare const RemarketingSetting: RemarketingSetting$Type;
export {};