Namespace Google.Ads.AdManager.V1

Classes

AdManagerError

/ AdManagerError contains all the information required for processing a / particular error thrown by the AdManager API. / / At least one AdManagerError should be included in all error messages sent to / the client.

AdUnit

The AdUnit resource.

AdUnitName

Resource name for the AdUnit resource.

AdUnitParent

The summary of a parent AdUnit.

AdUnitService

Provides methods for handling AdUnit objects.

AdUnitService.AdUnitServiceBase

Base class for server-side implementations of AdUnitService

AdUnitService.AdUnitServiceClient

Client for AdUnitService

AdUnitServiceClient

AdUnitService client wrapper, for convenient use.

AdUnitServiceClientBuilder

Builder class for AdUnitServiceClient to provide simple configuration of credentials, endpoint etc.

AdUnitServiceClientImpl

AdUnitService client wrapper implementation, for convenient use.

AdUnitServiceSettings

Settings for AdUnitServiceClient instances.

AdUnitSize

Represents the size, environment, and companions of an ad in an ad unit.

AdUnitStatusEnum

Wrapper message for [AdUnitStatus][google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus]

AdUnitStatusEnum.Types

Container for nested types declared in the AdUnitStatusEnum message type.

AppliedLabel

Represents a Label that can be applied to an entity.

BatchCreateEntitySignalsMappingsRequest

Request object for BatchCreateEntitySignalsMappings method.

BatchCreateEntitySignalsMappingsResponse

Response object for BatchCreateEntitySignalsMappings method.

BatchUpdateEntitySignalsMappingsRequest

Request object for BatchUpdateEntitySignalsMappings method.

BatchUpdateEntitySignalsMappingsResponse

Response object for BatchUpdateEntitySignalsMappings method.

Company

The Company resource.

CompanyCreditStatusEnum

Wrapper message for [CompanyCreditStatus][google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus]

CompanyCreditStatusEnum.Types

Container for nested types declared in the CompanyCreditStatusEnum message type.

CompanyName

Resource name for the Company resource.

CompanyService

Provides methods for handling Company objects.

CompanyService.CompanyServiceBase

Base class for server-side implementations of CompanyService

CompanyService.CompanyServiceClient

Client for CompanyService

CompanyServiceClient

CompanyService client wrapper, for convenient use.

CompanyServiceClientBuilder

Builder class for CompanyServiceClient to provide simple configuration of credentials, endpoint etc.

CompanyServiceClientImpl

CompanyService client wrapper implementation, for convenient use.

CompanyServiceSettings

Settings for CompanyServiceClient instances.

CompanyTypeEnum

Wrapper message for [CompanyType][google.ads.admanager.v1.CompanyTypeEnum.CompanyType]

CompanyTypeEnum.Types

Container for nested types declared in the CompanyTypeEnum message type.

Contact

A contact represents a person who is affiliated with a single company. A contact can have a variety of contact information associated to it, and can be invited to view their company's orders, line items, creatives, and reports.

ContactName

Resource name for the Contact resource.

CreateEntitySignalsMappingRequest

Request object for 'CreateEntitySignalsMapping' method.

CreateReportRequest

Request object for CreateReport method.

CustomField

An additional, user-created field on an entity.

CustomFieldDataTypeEnum

Wrapper message for [CustomFieldDataType][google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType]

CustomFieldDataTypeEnum.Types

Container for nested types declared in the CustomFieldDataTypeEnum message type.

CustomFieldEntityTypeEnum

Wrapper message for [CustomFieldEntityType][google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType]

CustomFieldEntityTypeEnum.Types

Container for nested types declared in the CustomFieldEntityTypeEnum message type.

CustomFieldName

Resource name for the CustomField resource.

CustomFieldOption

An option for a drop-down CustomField.

CustomFieldService

Provides methods for handling CustomField objects.

CustomFieldService.CustomFieldServiceBase

Base class for server-side implementations of CustomFieldService

CustomFieldService.CustomFieldServiceClient

Client for CustomFieldService

CustomFieldServiceClient

CustomFieldService client wrapper, for convenient use.

CustomFieldServiceClientBuilder

Builder class for CustomFieldServiceClient to provide simple configuration of credentials, endpoint etc.

CustomFieldServiceClientImpl

CustomFieldService client wrapper implementation, for convenient use.

CustomFieldServiceSettings

Settings for CustomFieldServiceClient instances.

CustomFieldStatusEnum

Wrapper message for [CustomFieldStatus][google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus]

CustomFieldStatusEnum.Types

Container for nested types declared in the CustomFieldStatusEnum message type.

CustomFieldValue

A value for a CustomField on a resource.

CustomFieldValue.Types

Container for nested types declared in the CustomFieldValue message type.

CustomFieldValue.Types.Value

Represent custom field value type. Next Id: 5

CustomFieldVisibilityEnum

Wrapper message for [CustomFieldVisibility][google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility]

CustomFieldVisibilityEnum.Types

Container for nested types declared in the CustomFieldVisibilityEnum message type.

CustomTargetingKey

The CustomTargetingKey resource.

CustomTargetingKeyName

Resource name for the CustomTargetingKey resource.

CustomTargetingKeyReportableTypeEnum

Wrapper message for [CustomTargetingKeyReportableType][google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType]

CustomTargetingKeyReportableTypeEnum.Types

Container for nested types declared in the CustomTargetingKeyReportableTypeEnum message type.

CustomTargetingKeyService

Provides methods for handling CustomTargetingKey objects.

CustomTargetingKeyService.CustomTargetingKeyServiceBase

Base class for server-side implementations of CustomTargetingKeyService

CustomTargetingKeyService.CustomTargetingKeyServiceClient

Client for CustomTargetingKeyService

CustomTargetingKeyServiceClient

CustomTargetingKeyService client wrapper, for convenient use.

CustomTargetingKeyServiceClientBuilder

Builder class for CustomTargetingKeyServiceClient to provide simple configuration of credentials, endpoint etc.

CustomTargetingKeyServiceClientImpl

CustomTargetingKeyService client wrapper implementation, for convenient use.

CustomTargetingKeyServiceSettings

Settings for CustomTargetingKeyServiceClient instances.

CustomTargetingKeyStatusEnum

Wrapper message for [CustomTargetingKeyStatus][google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus]

CustomTargetingKeyStatusEnum.Types

Container for nested types declared in the CustomTargetingKeyStatusEnum message type.

CustomTargetingKeyTypeEnum

Wrapper message for [CustomTargetingKeyType][google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyType]

CustomTargetingKeyTypeEnum.Types

Container for nested types declared in the CustomTargetingKeyTypeEnum message type.

CustomTargetingValue

The CustomTargetingValue resource.

CustomTargetingValueMatchTypeEnum

Wrapper message for [CustomTargetingValueMatchType][google.ads.admanager.v1.CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType]

CustomTargetingValueMatchTypeEnum.Types

Container for nested types declared in the CustomTargetingValueMatchTypeEnum message type.

CustomTargetingValueName

Resource name for the CustomTargetingValue resource.

CustomTargetingValueService

Provides methods for handling CustomTargetingValue objects.

CustomTargetingValueService.CustomTargetingValueServiceBase

Base class for server-side implementations of CustomTargetingValueService

CustomTargetingValueService.CustomTargetingValueServiceClient

Client for CustomTargetingValueService

CustomTargetingValueServiceClient

CustomTargetingValueService client wrapper, for convenient use.

CustomTargetingValueServiceClientBuilder

Builder class for CustomTargetingValueServiceClient to provide simple configuration of credentials, endpoint etc.

CustomTargetingValueServiceClientImpl

CustomTargetingValueService client wrapper implementation, for convenient use.

CustomTargetingValueServiceSettings

Settings for CustomTargetingValueServiceClient instances.

CustomTargetingValueStatusEnum

Wrapper message for [CustomTargetingValueStatus][google.ads.admanager.v1.CustomTargetingValueStatusEnum.CustomTargetingValueStatus]

CustomTargetingValueStatusEnum.Types

Container for nested types declared in the CustomTargetingValueStatusEnum message type.

EntitySignalsMapping

The EntitySignalsMapping resource.

EntitySignalsMappingName

Resource name for the EntitySignalsMapping resource.

EntitySignalsMappingService

Provides methods for handling EntitySignalsMapping objects.

EntitySignalsMappingService.EntitySignalsMappingServiceBase

Base class for server-side implementations of EntitySignalsMappingService

EntitySignalsMappingService.EntitySignalsMappingServiceClient

Client for EntitySignalsMappingService

EntitySignalsMappingServiceClient

EntitySignalsMappingService client wrapper, for convenient use.

EntitySignalsMappingServiceClientBuilder

Builder class for EntitySignalsMappingServiceClient to provide simple configuration of credentials, endpoint etc.

EntitySignalsMappingServiceClientImpl

EntitySignalsMappingService client wrapper implementation, for convenient use.

EntitySignalsMappingServiceSettings

Settings for EntitySignalsMappingServiceClient instances.

EnvironmentTypeEnum

Wrapper message for [EnvironmentType][google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType].

EnvironmentTypeEnum.Types

Container for nested types declared in the EnvironmentTypeEnum message type.

FetchReportResultRowsRequest

The request message for the fetch report result rows endpoint.

FetchReportResultRowsResponse

The response message for the fetch report result rows endpoint.

FrequencyCap

Represents a Frequency Cap that can be applied to an entity.

GetAdUnitRequest

Request object for GetAdUnit method.

GetCompanyRequest

Request object for GetCompany method.

GetCustomFieldRequest

Request object for GetCustomField method.

GetCustomTargetingKeyRequest

Request object for GetCustomTargetingKey method.

GetCustomTargetingValueRequest

Request object for GetCustomTargetingValue method.

GetEntitySignalsMappingRequest

Request object for GetEntitySignalsMapping method.

GetNetworkRequest

Request to get Network

GetOrderRequest

Request object for GetOrder method.

GetPlacementRequest

Request object for GetPlacement method.

GetReportRequest

Request object for GetReport method.

GetRoleRequest

Request object for GetRole method.

GetTaxonomyCategoryRequest

Request object for GetTaxonomyCategory method.

GetUserRequest

Request object for GetUser method.

Label

A Label is additional information that can be added to an entity.

LabelFrequencyCap

Frequency cap using a label.

LabelName

Resource name for the Label resource.

ListAdUnitSizesRequest

Request object for ListAdUnitSizes method.

ListAdUnitSizesResponse

Response object for ListAdUnitSizesRequest containing matching AdUnitSizes.

ListAdUnitsRequest

Request object for ListAdUnits method.

ListAdUnitsResponse

Response object for ListAdUnitsRequest containing matching AdUnit resources.

ListCompaniesRequest

Request object for ListCompanies method.

ListCompaniesResponse

Response object for ListCompaniesRequest containing matching Company objects.

ListCustomFieldsRequest

Request object for ListCustomFields method.

ListCustomFieldsResponse

Response object for ListCustomFieldsRequest containing matching CustomField objects.

ListCustomTargetingKeysRequest

Request object for ListCustomTargetingKeys method.

ListCustomTargetingKeysResponse

Response object for ListCustomTargetingKeysRequest containing matching CustomTargetingKey objects.

ListCustomTargetingValuesRequest

Request object for ListCustomTargetingValues method.

ListCustomTargetingValuesResponse

Response object for ListCustomTargetingValuesRequest containing matching CustomTargetingValue objects.

ListEntitySignalsMappingsRequest

Request object for ListEntitySignalsMappings method.

ListEntitySignalsMappingsResponse

Response object for ListEntitySignalsMappingsRequest containing matching EntitySignalsMapping resources.

ListNetworksRequest

Request object for ListNetworks method.

ListNetworksResponse

Response object for ListNetworks method.

ListOrdersRequest

Request object for ListOrders method.

ListOrdersResponse

Response object for ListOrdersRequest containing matching Order resources.

ListPlacementsRequest

Request object for ListPlacements method.

ListPlacementsResponse

Response object for ListPlacementsRequest containing matching Placement objects.

ListReportsRequest

Request object for ListReports method.

ListReportsResponse

Response object for ListReportsResponse containing matching Report objects.

ListRolesRequest

Request object for ListRoles method.

ListRolesResponse

Response object for ListRolesRequest containing matching Role objects.

ListTaxonomyCategoriesRequest

Request object for ListTaxonomyCategories method.

ListTaxonomyCategoriesResponse

Response object for ListTaxonomyCategoriesRequest containing matching TaxonomyCategory objects.

Network

The Network resource.

NetworkName

Resource name for the Network resource.

NetworkService

Provides methods for handling Network objects.

NetworkService.NetworkServiceBase

Base class for server-side implementations of NetworkService

NetworkService.NetworkServiceClient

Client for NetworkService

NetworkServiceClient

NetworkService client wrapper, for convenient use.

NetworkServiceClientBuilder

Builder class for NetworkServiceClient to provide simple configuration of credentials, endpoint etc.

NetworkServiceClientImpl

NetworkService client wrapper implementation, for convenient use.

NetworkServiceSettings

Settings for NetworkServiceClient instances.

Order

The Order resource.

OrderName

Resource name for the Order resource.

OrderService

Provides methods for handling Order objects.

OrderService.OrderServiceBase

Base class for server-side implementations of OrderService

OrderService.OrderServiceClient

Client for OrderService

OrderServiceClient

OrderService client wrapper, for convenient use.

OrderServiceClientBuilder

Builder class for OrderServiceClient to provide simple configuration of credentials, endpoint etc.

OrderServiceClientImpl

OrderService client wrapper implementation, for convenient use.

OrderServiceSettings

Settings for OrderServiceClient instances.

OrderStatusEnum

Wrapper message for [OrderStatus][google.ads.admanager.v1.OrderStatusEnum.OrderStatus].

OrderStatusEnum.Types

Container for nested types declared in the OrderStatusEnum message type.

Placement

The Placement resource.

PlacementName

Resource name for the Placement resource.

PlacementService

Provides methods for handling Placement objects.

PlacementService.PlacementServiceBase

Base class for server-side implementations of PlacementService

PlacementService.PlacementServiceClient

Client for PlacementService

PlacementServiceClient

PlacementService client wrapper, for convenient use.

PlacementServiceClientBuilder

Builder class for PlacementServiceClient to provide simple configuration of credentials, endpoint etc.

PlacementServiceClientImpl

PlacementService client wrapper implementation, for convenient use.

PlacementServiceSettings

Settings for PlacementServiceClient instances.

PlacementStatusEnum

Wrapper message for [PlacementStatus][google.ads.admanager.v1.PlacementStatusEnum.PlacementStatus]

PlacementStatusEnum.Types

Container for nested types declared in the PlacementStatusEnum message type.

Report

The Report resource.

Report.Types

Container for nested types declared in the Report message type.

Report.Types.DataTable

A table containing report data including dimension and metric values.

Report.Types.DataTable.Types

Container for nested types declared in the DataTable message type.

Report.Types.DataTable.Types.MetricValueGroup

Contains all metric values requested for a single date range and set of column dimension values (returned in the columns field of the response). The order of the metrics in each field corresponds to the order of the metrics specified in the request.

Report.Types.DataTable.Types.Row

A row of report data.

Report.Types.DateRange

A date range for a report.

Report.Types.DateRange.Types

Container for nested types declared in the DateRange message type.

Report.Types.DateRange.Types.FixedDateRange

A date range between two fixed dates (inclusive of end date).

Report.Types.Field

A dimension or a metric in a report.

Report.Types.Filter

A filter over one or more fields.

Report.Types.Filter.Types

Container for nested types declared in the Filter message type.

Report.Types.Filter.Types.FieldFilter

A filter on a specific field.

Report.Types.Filter.Types.FilterList

A list of filters.

Report.Types.Flag

A flag for a report. Flags are used show if certain thresholds are met. Result rows that match the filter will have the corresponding [MetricValueGroup.flagValues][MetricValueGroup] index set to true. For more information about flags see: https://support.google.com/admanager/answer/15079975

Report.Types.Slice

Use to specify a slice of data.

For example, in a report, to focus on just data from the US, specify COUNTRY_NAME for dimension and value: "United States".

Report.Types.Sort

Represents a sorting in a report.

Report.Types.Value

Represents a single value in a report.

Report.Types.Value.Types

Container for nested types declared in the Value message type.

Report.Types.Value.Types.IntList

A list of integer values.

Report.Types.Value.Types.StringList

A list of string values.

ReportDefinition

The definition of how a report should be run.

ReportName

Resource name for the Report resource.

ReportService

Provides methods for interacting with reports.

ReportService.ReportServiceBase

Base class for server-side implementations of ReportService

ReportService.ReportServiceClient

Client for ReportService

ReportServiceClient

ReportService client wrapper, for convenient use.

ReportServiceClientBuilder

Builder class for ReportServiceClient to provide simple configuration of credentials, endpoint etc.

ReportServiceClientImpl

ReportService client wrapper implementation, for convenient use.

ReportServiceSettings

Settings for ReportServiceClient instances.

Role

The Role resource.

RoleName

Resource name for the Role resource.

RoleService

Provides methods for handling Role objects.

RoleService.RoleServiceBase

Base class for server-side implementations of RoleService

RoleService.RoleServiceClient

Client for RoleService

RoleServiceClient

RoleService client wrapper, for convenient use.

RoleServiceClientBuilder

Builder class for RoleServiceClient to provide simple configuration of credentials, endpoint etc.

RoleServiceClientImpl

RoleService client wrapper implementation, for convenient use.

RoleServiceSettings

Settings for RoleServiceClient instances.

RoleStatusEnum

Wrapper message for [RoleStatus][google.ads.admanager.v1.RoleStatusEnum.RoleStatus]

RoleStatusEnum.Types

Container for nested types declared in the RoleStatusEnum message type.

RunReportMetadata

RunReport operation metadata.

RunReportRequest

Request message for a running a report.

RunReportResponse

Response message for a completed RunReport operation.

Schedule

The schedule for the report

Schedule.Types

Container for nested types declared in the Schedule message type.

Schedule.Types.MonthlySchedule

Days of Month to schedule report run.

Schedule.Types.WeeklySchedule

Days of week to schedule report run.

ScheduleOptions

The options for a scheduled report.

ScheduleOptions.Types

Container for nested types declared in the ScheduleOptions message type.

Size

Represents the dimensions of an AdUnit, LineItem, or Creative.

SizeTypeEnum

Wrapper message for [SizeType][google.ads.admanager.v1.SizeTypeEnum.SizeType].

SizeTypeEnum.Types

Container for nested types declared in the SizeTypeEnum message type.

SmartSizeModeEnum

Wrapper message for [SmartSizeMode][google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode].

SmartSizeModeEnum.Types

Container for nested types declared in the SmartSizeModeEnum message type.

TargetWindowEnum

Wrapper message for [TargetWindow][google.ads.admanager.v1.TargetWindowEnum.TargetWindow].

TargetWindowEnum.Types

Container for nested types declared in the TargetWindowEnum message type.

TaxonomyCategory

The TaxonomyCategory resource.

TaxonomyCategoryName

Resource name for the TaxonomyCategory resource.

TaxonomyCategoryService

Provides methods for handling TaxonomyCategory objects.

TaxonomyCategoryService.TaxonomyCategoryServiceBase

Base class for server-side implementations of TaxonomyCategoryService

TaxonomyCategoryService.TaxonomyCategoryServiceClient

Client for TaxonomyCategoryService

TaxonomyCategoryServiceClient

TaxonomyCategoryService client wrapper, for convenient use.

TaxonomyCategoryServiceClientBuilder

Builder class for TaxonomyCategoryServiceClient to provide simple configuration of credentials, endpoint etc.

TaxonomyCategoryServiceClientImpl

TaxonomyCategoryService client wrapper implementation, for convenient use.

TaxonomyCategoryServiceSettings

Settings for TaxonomyCategoryServiceClient instances.

TaxonomyTypeEnum

Wrapper for [TaxonomyType][google.ads.admanager.v1.TaxonomyTypeEnum.TaxonomyType]

TaxonomyTypeEnum.Types

Container for nested types declared in the TaxonomyTypeEnum message type.

Team

A Team defines a grouping of users and what entities they have access to.

TeamName

Resource name for the Team resource.

TimeUnitEnum

Wrapper message for TimeUnit.

TimeUnitEnum.Types

Container for nested types declared in the TimeUnitEnum message type.

UpdateEntitySignalsMappingRequest

Request object for 'UpdateEntitySignalsMapping' method.

UpdateReportRequest

Request object for UpdateReport method.

User

The User resource.

UserName

Resource name for the User resource.

UserService

Provides methods for handling User objects.

UserService.UserServiceBase

Base class for server-side implementations of UserService

UserService.UserServiceClient

Client for UserService

UserServiceClient

UserService client wrapper, for convenient use.

UserServiceClientBuilder

Builder class for UserServiceClient to provide simple configuration of credentials, endpoint etc.

UserServiceClientImpl

UserService client wrapper implementation, for convenient use.

UserServiceSettings

Settings for UserServiceClient instances.

Enums

AdUnitName.ResourceNameType

The possible contents of AdUnitName.

AdUnitStatusEnum.Types.AdUnitStatus

The status of an AdUnit.

CompanyCreditStatusEnum.Types.CompanyCreditStatus

The credit status of a company.

Credit statuses specify the credit-worthiness of a company and affect the ad serving of campaigns belonging to the company.

In basic settings, only the [ACTIVE][google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus.ACTIVE] and [INACTIVE][google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus.INACTIVE] credit statuses are applicable. In advance settings, all credit statuses are applicable.