google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
78 lines (77 loc) • 3.03 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 { SharedSetStatusEnum_SharedSetStatus } from "../enums/shared_set_status";
import { SharedSetTypeEnum_SharedSetType } from "../enums/shared_set_type";
/**
* SharedSets are used for sharing criterion exclusions across multiple
* campaigns.
*
* @generated from protobuf message google.ads.googleads.v11.resources.SharedSet
*/
export interface SharedSet {
/**
* Immutable. The resource name of the shared set.
* Shared set resource names have the form:
*
* `customers/{customer_id}/sharedSets/{shared_set_id}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Output only. The ID of this shared set. Read only.
*
* @generated from protobuf field: optional int64 id = 8;
*/
id?: bigint;
/**
* Immutable. The type of this shared set: each shared set holds only a single kind
* of resource. Required. Immutable.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.SharedSetTypeEnum.SharedSetType type = 3;
*/
type: SharedSetTypeEnum_SharedSetType;
/**
* The name of this shared set. Required.
* Shared Sets must have names that are unique among active shared sets of
* the same type.
* The length of this string should be between 1 and 255 UTF-8 bytes,
* inclusive.
*
* @generated from protobuf field: optional string name = 9;
*/
name?: string;
/**
* Output only. The status of this shared set. Read only.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.SharedSetStatusEnum.SharedSetStatus status = 5;
*/
status: SharedSetStatusEnum_SharedSetStatus;
/**
* Output only. The number of shared criteria within this shared set. Read only.
*
* @generated from protobuf field: optional int64 member_count = 10;
*/
memberCount?: bigint;
/**
* Output only. The number of campaigns associated with this shared set. Read only.
*
* @generated from protobuf field: optional int64 reference_count = 11;
*/
referenceCount?: bigint;
}
declare class SharedSet$Type extends MessageType<SharedSet> {
constructor();
create(value?: PartialMessage<SharedSet>): SharedSet;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: SharedSet): SharedSet;
internalBinaryWrite(message: SharedSet, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.SharedSet
*/
export declare const SharedSet: SharedSet$Type;
export {};