google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
99 lines (98 loc) • 3.71 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 { AdStrengthEnum_AdStrength } from "../enums/ad_strength";
import { AssetGroupStatusEnum_AssetGroupStatus } from "../enums/asset_group_status";
/**
* An asset group.
* AssetGroupAsset is used to link an asset to the asset group.
* AssetGroupSignal is used to associate a signal to an asset group.
*
* @generated from protobuf message google.ads.googleads.v11.resources.AssetGroup
*/
export interface AssetGroup {
/**
* Immutable. The resource name of the asset group.
* Asset group resource names have the form:
*
* `customers/{customer_id}/assetGroups/{asset_group_id}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Output only. The ID of the asset group.
*
* @generated from protobuf field: int64 id = 9;
*/
id: bigint;
/**
* Immutable. The campaign with which this asset group is associated.
* The asset which is linked to the asset group.
*
* @generated from protobuf field: string campaign = 2;
*/
campaign: string;
/**
* Required. Name of the asset group. Required. It must have a minimum length of 1 and
* maximum length of 128. It must be unique under a campaign.
*
* @generated from protobuf field: string name = 3;
*/
name: string;
/**
* A list of final URLs after all cross domain redirects. In performance max,
* by default, the urls are eligible for expansion unless opted out.
*
* @generated from protobuf field: repeated string final_urls = 4;
*/
finalUrls: string[];
/**
* A list of final mobile URLs after all cross domain redirects. In
* performance max, by default, the urls are eligible for expansion
* unless opted out.
*
* @generated from protobuf field: repeated string final_mobile_urls = 5;
*/
finalMobileUrls: string[];
/**
* The status of the asset group.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.AssetGroupStatusEnum.AssetGroupStatus status = 6;
*/
status: AssetGroupStatusEnum_AssetGroupStatus;
/**
* First part of text that may appear appended to the url displayed in
* the ad.
*
* @generated from protobuf field: string path1 = 7;
*/
path1: string;
/**
* Second part of text that may appear appended to the url displayed in
* the ad. This field can only be set when path1 is set.
*
* @generated from protobuf field: string path2 = 8;
*/
path2: string;
/**
* Output only. Overall ad strength of this asset group.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.AdStrengthEnum.AdStrength ad_strength = 10;
*/
adStrength: AdStrengthEnum_AdStrength;
}
declare class AssetGroup$Type extends MessageType<AssetGroup> {
constructor();
create(value?: PartialMessage<AssetGroup>): AssetGroup;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AssetGroup): AssetGroup;
internalBinaryWrite(message: AssetGroup, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.AssetGroup
*/
export declare const AssetGroup: AssetGroup$Type;
export {};