google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
153 lines (152 loc) • 5.53 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 { ChangeStatusOperationEnum_ChangeStatusOperation } from "../enums/change_status_operation";
import { ChangeStatusResourceTypeEnum_ChangeStatusResourceType } from "../enums/change_status_resource_type";
/**
* Describes the status of returned resource. ChangeStatus could have up to 3
* minutes delay to reflect a new change.
*
* @generated from protobuf message google.ads.googleads.v11.resources.ChangeStatus
*/
export interface ChangeStatus {
/**
* Output only. The resource name of the change status.
* Change status resource names have the form:
*
* `customers/{customer_id}/changeStatus/{change_status_id}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Output only. Time at which the most recent change has occurred on this resource.
*
* @generated from protobuf field: optional string last_change_date_time = 24;
*/
lastChangeDateTime?: string;
/**
* Output only. Represents the type of the changed resource. This dictates what fields
* will be set. For example, for AD_GROUP, campaign and ad_group fields will
* be set.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.ChangeStatusResourceTypeEnum.ChangeStatusResourceType resource_type = 4;
*/
resourceType: ChangeStatusResourceTypeEnum_ChangeStatusResourceType;
/**
* Output only. The Campaign affected by this change.
*
* @generated from protobuf field: optional string campaign = 17;
*/
campaign?: string;
/**
* Output only. The AdGroup affected by this change.
*
* @generated from protobuf field: optional string ad_group = 18;
*/
adGroup?: string;
/**
* Output only. Represents the status of the changed resource.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.ChangeStatusOperationEnum.ChangeStatusOperation resource_status = 8;
*/
resourceStatus: ChangeStatusOperationEnum_ChangeStatusOperation;
/**
* Output only. The AdGroupAd affected by this change.
*
* @generated from protobuf field: optional string ad_group_ad = 25;
*/
adGroupAd?: string;
/**
* Output only. The AdGroupCriterion affected by this change.
*
* @generated from protobuf field: optional string ad_group_criterion = 26;
*/
adGroupCriterion?: string;
/**
* Output only. The CampaignCriterion affected by this change.
*
* @generated from protobuf field: optional string campaign_criterion = 27;
*/
campaignCriterion?: string;
/**
* Output only. The Feed affected by this change.
*
* @generated from protobuf field: optional string feed = 28;
*/
feed?: string;
/**
* Output only. The FeedItem affected by this change.
*
* @generated from protobuf field: optional string feed_item = 29;
*/
feedItem?: string;
/**
* Output only. The AdGroupFeed affected by this change.
*
* @generated from protobuf field: optional string ad_group_feed = 30;
*/
adGroupFeed?: string;
/**
* Output only. The CampaignFeed affected by this change.
*
* @generated from protobuf field: optional string campaign_feed = 31;
*/
campaignFeed?: string;
/**
* Output only. The AdGroupBidModifier affected by this change.
*
* @generated from protobuf field: optional string ad_group_bid_modifier = 32;
*/
adGroupBidModifier?: string;
/**
* Output only. The SharedSet affected by this change.
*
* @generated from protobuf field: string shared_set = 33;
*/
sharedSet: string;
/**
* Output only. The CampaignSharedSet affected by this change.
*
* @generated from protobuf field: string campaign_shared_set = 34;
*/
campaignSharedSet: string;
/**
* Output only. The Asset affected by this change.
*
* @generated from protobuf field: string asset = 35;
*/
asset: string;
/**
* Output only. The CustomerAsset affected by this change.
*
* @generated from protobuf field: string customer_asset = 36;
*/
customerAsset: string;
/**
* Output only. The CampaignAsset affected by this change.
*
* @generated from protobuf field: string campaign_asset = 37;
*/
campaignAsset: string;
/**
* Output only. The AdGroupAsset affected by this change.
*
* @generated from protobuf field: string ad_group_asset = 38;
*/
adGroupAsset: string;
}
declare class ChangeStatus$Type extends MessageType<ChangeStatus> {
constructor();
create(value?: PartialMessage<ChangeStatus>): ChangeStatus;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ChangeStatus): ChangeStatus;
internalBinaryWrite(message: ChangeStatus, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.ChangeStatus
*/
export declare const ChangeStatus: ChangeStatus$Type;
export {};