接続の確立

Google Ad Manager への接続を追加

Google Ad Manager への接続を追加するには：

アプリケーションコンソールで、接続ページに移動します。
接続の追加パネルで、追加したい接続のアイコンを選択します。
Google Ad Manager アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからGoogle Ad Manager コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Google Ad Manager への接続

認証プロパティを追加する前に、次の接続プロパティを設定してください。

NetworkCode：NetworkCode 接続プロパティを、ネットワークにログインしているときにURL に表示されているネットワークコードに設定。例えば、URL がhttps://admanager.google.com/2032576/#inventory の場合、2032576 があなたのネットワークコードです。

Google Ad Manager への認証

Sync App は、認証にユーザーアカウントおよびGCP インスタンスアカウントの使用をサポートします。

以下のセクションでは、Google Ad Manager の利用可能な認証スキームについて説明します。

ユーザーアカウント（OAuth）
サービスアカウント（OAuthJWT）
GCP インスタンスアカウント

ユーザーアカウント（OAuth）

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

Web アプリケーション

Web アプリケーション経由で接続する場合は、Google Ad Manager にカスタムOAuth アプリケーションを作成および登録する必要があります。それからSync App を使用してOAuth トークンの値を取得および管理します。カスタムアプリケーションについて詳しくは、カスタムOAuth アプリの作成を参照してください。

OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

OAuthClientId：アプリケーション設定のクライアントId に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをアプリケーション設定で指定したコールバックURL に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
ステップ1でストアドプロシージャが返したURL に移動します。カスタムOAuth アプリケーションにログインして、Web アプリケーションを認可します。認証されると、ブラウザはコールバックURL にリダイレクトします。
GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode をWEB に、Verifier インプットをコールバックURL のクエリ文字列の"code" パラメータに設定します。

アクセストークンとリフレッシュトークンを取得すると、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることができるようになります。

OAuth アクセストークンの自動リフレッシュ

ドライバーがOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。

InitiateOAuth：REFRESH に設定。
OAuthClientId：アプリケーション設定のクライアントId に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークンに設定。
OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークンに設定。
OAuthSettingsLocation：Sync App がOAuth トークン値を保存する場所に設定。これは接続間で維持されます。

次回のデータ接続では、OAuthAccessToken およびOAuthRefreshToken の値は、OAuthSettingsLocation から取得されます。

OAuth アクセストークンの手動リフレッシュ

データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。

GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。

OAuthClientId：アプリケーション設定のクライアントId に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。

次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。

最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

以下のオプションから選択します。
- オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
- オプション2：インターネットブラウザに対応したマシンにSync App をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにSync App を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

以下のオプションから選択します。
- 埋め込みOAuth アプリケーションを使用する場合は、Google Ad Manager OAuth endpoint をクリックし、ブラウザでエンドポイントを開きます。
- カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
  - InitiateOAuth：OFF に設定。
  - OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  - OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
ログインして、Sync App にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

InitiateOAuth：REFRESH に設定。
OAuthVerifier：verifier code に設定。
OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

InitiateOAuth：REFRESH に設定。
OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
OAuthSettingsLocation：暗号化されたOAuth 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がSync App に読み書きのアクセス許可を与えることを確認してください。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

InitiateOAuth：REFRESH に設定。
OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がSync App に読み書きのアクセス許可を与えることを確認してください。

GCP インスタンスアカウント

GCP 仮想マシン上で実行している場合は、Sync App は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。

高度な機能

このセクションでは、Google Ad Manager Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Google Ad Manager にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングでは、次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、より洗練されたロギングをサポートする多数の機能があります。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

CData Sync App はGoogle Ad Manager オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。 Google Ad Manager オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。次のセクションでは、利用可能なAPI オブジェクトを示し、Google Ad Manager API へのSQL の実行について詳しく説明します。

ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。ただし、保存済みのクエリレポートのスキーマは動的に取得されます。

保存済みのクエリレポートへのアクセス

接続時にSync App は、適切なWeb サービスを呼び出してレポートのリストとテーブルのメタデータを取得します。Sync App を使用して接続すると、新しいレポートの追加、新しいフィールドの追加、フィールドのデータ型の変更など、保存済みのクエリレポートに対して行う変更は即座に反映されます。

カスタムフィールドの挿入

When executing an Insert statement and you've specified a custom field, the value of the custom field must be an aggregate. The aggregate must contain the ID of the custom field and the value that you want to give it. You can get custom fields' IDs by querying CustomFields table. Currently, only custom fields of type "Text" are supported for Insert. Other types are not insertable/updatable.

Below is an example of inserting into Orders table while specifying the "MyOwnCustomField" custom field. The ID of the custom field is 1238676 and its value is "Sample text here".

INSERT INTO Orders (Name, Notes, AdvertiserId, TraffickerId, CreatorId, Status, MyOwnCustomField) VALUES ('T-Shirt', 'Note description', '7412504329', '452586926', '9521226', 'DRAFT', '<customFieldId> 1238676 </customFieldId><value xsi:type="TextValue"><value> Sample text here </value></value>')

テーブル

Sync App はGoogle Ad Manager のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Google Ad Manager Connector for CData Sync テーブル


Name	Description
Companies	Create, update, and query DoubleClick for Publishers Companies.
Contacts	Create, update, and query DoubleClick for Publishers Contacts.
Creatives	Update and query DoubleClick for Publishers Creatives.
CustomFields	Create, update, and query DoubleClick for Publishers Custom Fields.
CustomTargetingKeys	Create, update, and query DoubleClick for Publishers Custom Targeting Keys.
CustomTargetingValues	Create, update, and query DoubleClick for Publishers Custom Targeting Values.
Inventories	Create, update, and query DoubleClick for Publishers Inventories.
Labels	Create, update, delete, and query DoubleClick for Publishers Labels.
LineItemCreativeAssociations	Query DoubleClick for Publishers LineItemCreativeAssociations.
LineItems	Create, update, delete, and query DoubleClick for Publishers Line Items.
MobileApplications	Create and query DoubleClick for Publishers Mobile Applications.
Orders	Create, update, delete, and query DoubleClick for Publishers Orders.
Placements	Create, update, delete, and query DoubleClick for Publishers Placements.
ProposalLineItems	Create, update, and query DoubleClick for Publishers ProposalLineItems.
Proposals	Create, update, and query DoubleClick for Publishers Proposals.
Users	Create, update, delete, and query DoubleClick for Publishers Users.

Companies

Create, update, and query DoubleClick for Publishers Companies.

Select

The following queries are processed server side.

Retrieve a list of Companies. For example:

SELECT * FROM [Companies]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [Companies] WHERE Id = '4410125029'

Insert

To create a new Company, the Name and Type fields are required.

INSERT INTO [Companies] (Name, Type) VALUES ('CompName', 'ADVERTISER')

Update

You can update any field not marked as read-only by specifying the Id column.

UPDATE [Companies] SET Name = 'New CompName' WHERE Id = '4410125029'

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Uniquely identifies the Company. This value is read-only and is assigned by Google when the company is created. This attribute is required for updates.
Name	String	False	The full name of the company. This attribute is required and has a maximum length of 127 characters.
Type	String	False	Specifies what kind of company this is. This attribute is required. 使用できる値は次のとおりです。HOUSE_ADVERTISER, HOUSE_AGENCY, ADVERTISER, AGENCY, AD_NETWORK, PARTNER, CHILD_PUBLISHER, VIEWABILITY_PROVIDER, UNKNOWN
Address	String	False	Specifies the address of the company. This attribute is optional and has a maximum length of 65,535 characters.
Email	String	False	Specifies the email of the company. This attribute is optional and has a maximum length of 128 characters.
FaxPhone	String	False	Specifies the fax phone number of the company. This attribute is optional and has a maximum length of 63 characters.
PrimaryPhone	String	False	Specifies the primary phone number of the company. This attribute is optional and has a maximum length of 63 characters.
ExternalId	String	False	Specifies the external ID of the company. This attribute is optional and has a maximum length of 255 characters.
Comment	String	False	Specifies the comment of the company. This attribute is optional and has a maximum length of 1024 characters.
CreditStatus	String	False	Specifies the company's credit status. This attribute is optional and defaults to CreditStatus.ACTIVE when basic credit status settings are enabled, and CreditStatus.ON_HOLD when advanced credit status settings are enabled. 使用できる値は次のとおりです。ACTIVE, ON_HOLD, CREDIT_STOP, INACTIVE, BLOCKED
Settings	String	False	Specifies the default billing settings of this Company. This attribute is optional.
AppliedLabels	String	False	The set of labels applied to this company.
PrimaryContactId	Long	False	The ID of the Contact who is acting as the primary contact for this company. This attribute is optional.
AppliedTeamIds	String	False	The IDs of all teams that this company is on directly.
ThirdPartyCompanyId	Int	False	Specifies the ID of the Google-recognized canonicalized form of this company. This attribute is optional.
LastModifiedDateTime	Datetime	True	The date and time this company was last modified.
ChildPublisher	String	False	Info required for when Company Type is CHILD_PUBLISHER.
ViewabilityProvider	String	False	Info required for when Company Type is VIEWABILITY_PROVIDER.

Contacts

Create, update, and query DoubleClick for Publishers Contacts.

Select

The following queries are processed server side.

Retrieve a list of Contacts. For example:

SELECT * FROM [Contacts]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [Contacts] WHERE Id = '4940864'

Insert

To create a new Contact, the Name and CompanyId fields are required.

INSERT INTO [Contacts] (Name, CompanyId) VALUES ('Cont', '4415064655')

Update

You can update any field not marked as read-only by specifying the Id column.

UPDATE [Contacts] SET Name = 'New Contact', Email = '[email protected]' WHERE Id = '4944377'

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	The unique ID of the Contact. This value is readonly and is assigned by Google.
Name	String	False	The name of the contact. This attribute is required and has a maximum length of 127 characters.
CompanyId	Long	False	The ID of the Company that this contact is associated with. This attribute is required and immutable.
Status	String	True	The status of the contact. This attribute is readonly and is assigned by Google. 使用できる値は次のとおりです。UNINVITED, INVITE_PENDNG, INVITE_EXPIRED, INVITE_CANCELED, USER_ACTIVE, USER_DISABLED, UNKNOWN
Address	String	False	The address of the contact. This attribute is optional and has a maximum length of 1024 characters.
CellPhone	String	False	The cell phone number where the contact can be reached. This attribute is optional.
Comment	String	False	A free-form text comment for the contact. This attribute is optional and has a maximum length of 1024 characters.
Email	String	False	The e-mail address where the contact can be reached. This attribute is optional.
FaxPhone	String	False	The fax number where the contact can be reached. This attribute is optional.
Title	String	False	The job title of the contact. This attribute is optional and has a maximum length of 1024 characters.
WorkPhone	String	False	The work phone number where the contact can be reached. This attribute is optional.

Creatives

Update and query DoubleClick for Publishers Creatives.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Creatives. For example:

SELECT * FROM [Creatives]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [Creatives] WHERE Id = '138206791680'

Update

You can update any field not marked as read-only by specifying the Id column.

UPDATE [Creatives] SET Name = 'Updated creative' WHERE Id = '138206791680'

Insert

The INSERT operation is not supported for this table.

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
AdvertiserId	Long	False	The ID of the advertiser that owns the creative. This attribute is required.
Id [KEY]	Long	True	Uniquely identifies the Creative. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.
Name	String	False	The name of the creative. This attribute is required and has a maximum length of 255 characters.
Width	Int	False	The width of the Creative.
Height	Int	False	The height of the Creative.
IsAspectRatio	Bool	False	Whether the size defined by height and width represents an aspect ratio.
PreviewUrl	String	True	The URL of the creative for previewing the media. This attribute is read-only and is assigned by Google when a creative is created.
PolicyLabels	String	True	Set of policy labels detected for this creative. This attribute is read-only.
AppliedLabels	String	False	The set of labels applied to this creative.
LastModifiedDateTime	Datetime	True	The date and time this creative was last modified.
ThirdPartyDataDeclaration	String	False	The third party companies associated with this creative. This is distinct from any associated companies that Google may detect programmatically.
Snippet	String	True	The HTML snippet that this creative delivers. This attribute is required.
ExpandedSnippet	String	True	The HTML snippet that this creative delivers with macros expanded. This attribute is read-only and is set by Google.
CreativeTemplateVariableValues	String	False	Stores values of CreativeTemplateVariable in the CreativeTemplate.
SslScanResult	String	True	The SSL compatibility scan result for this creative.
SslManualOverride	String	False	The manual override for the SSL compatibility of this creative. This attribute is optional and defaults to SslManualOverride.NO_OVERRIDE.
LockedOrientation	String	True	A locked orientation for this creative to be displayed in.
AssetSize	String	True	The asset size of an internal redirect creative. Note that this may differ from size if users set overrideSize to true. This attribute is read-only and is populated by Google.
InternalRedirectUrl	String	False	The internal redirect URL of the DFA or DART for Publishers hosted creative. This attribute has a maximum length of 1024 characters.
IsSafeFrameCompatible	Bool	True	Whether the Creative is compatible for SafeFrame rendering.
Html5Asset	String	False	The HTML5 asset. To preview the HTML5 asset, use the CreativeAsset.assetUrl. In this field, the CreativeAsset.assetByteArray must be a zip bundle and the CreativeAsset.fileName must have a zip extension.
DestinationUrl	String	False	The URL the user is directed to if they click on the creative. This attribute is only required if the template snippet contains the %u or %%DEST_URL%% macro. It has a maximum length of 1024 characters
DestinationUrlType	String	False	The action that should be performed if the user clicks on the creative. This attribute is optional and defaults to DestinationUrlType.CLICK_TO_WEB.
HtmlSnippet	String	False	The HTML snippet that this creative delivers.
CustomCreativeAssets	String	False	A list of file assets that are associated with this creative, and can be referenced in the snippet.
OverrideSize	Bool	True	Allows the creative size to differ from the actual HTML5 asset size. This attribute is optional. thirdPartyImpressionTrackingUrls.
IsInterstitial	Bool	False	True if this internal redirect creative is interstitial.
PrimaryImageId	Long	True	Uniquely identifies the Creative. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.
PrimaryImageName	String	True	The name of the creative. This attribute is required and has a maximum length of 255 characters.
PrimaryImageSize	Long	True	Primary image size.
PrimaryImageUrl	String	True	Primary image url.
AltText	String	False	Alternative text to be rendered along with the creative used mainly for accessibility. This field is optional and has a maximum length of 500 characters.
ThirdPartyImpressionTrackingUrls	String	False	A list of impression tracking URL to ping when this creative is displayed. This field is optional and each string has a maximum length of 1024 characters.
AmpRedirectUrl	String	False	The URL of the AMP creative.

CustomFields

Create, update, and query DoubleClick for Publishers Custom Fields.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of CustomFields. For example:

SELECT * FROM [CustomFields]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [CustomFields] WHERE Id = '1238676'

Insert

To create a new CustomField, the Name, EntityType, DataType, and Visibility fields are required.

INSERT INTO [CustomFields] (Name, EntityType, DataType, Visibility) VALUES ('ASEF', 'LINE_ITEM', 'STRING', 'FULL')

Update

You can update any field not marked as read-only by specifying the Id column.

UPDATE [CustomFields] SET Description = 'New Description' WHERE Id = '1238676'

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique ID of the CustomField. This value is readonly and is assigned by Google.
Name	String	False	Name of the CustomField. This value is required to create a custom field. The max length is 127 characters.
Description	String	False	A description of the custom field. This value is optional. The maximum length is 511 characters.
IsActive	Boolean	True	Specifies whether or not the custom field is active. This attribute is read-only.
EntityType	String	False	The type of entity that this custom field is associated with. This attribute is read-only if there exists a CustomFieldValue for this field. 使用できる値は次のとおりです。LINE_ITEM, ORDER, CREATIVE, PRODUCT_TEMPLATE, PRODUCT, PROPOSAL, PROPOSAL_LINE_ITEM, USER, UNKNOWN
DataType	String	False	The type of data this custom field contains. This attribute is read-only if a CustomFieldValue exists for this field. 使用できる値は次のとおりです。STRING, NUMBER, TOGGLE, DROP_DOWN, UNKNOWN
Visibility	String	False	How visible/accessible this field is in the UI. 使用できる値は次のとおりです。API_ONLY, READ_ONLY, FULL

CustomTargetingKeys

Create, update, and query DoubleClick for Publishers Custom Targeting Keys.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of CustomFields. For example:

SELECT * FROM [CustomTargetingKeys]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [CustomTargetingKeys] WHERE Id = '10721398'

INSERT

To create a new CustomTargetingKey, the Name and Type fields are required.

INSERT INTO [CustomTargetingKeys] (Name, Type) VALUES ('tg_key', 'PREDEFINED')

Update

You can update any field not marked as read-only (except Name column that can only be inserted), by specifying the Id column.

UPDATE [CustomTargetingKeys] SET DisplayName = 'targeting key (Deprecated)' WHERE Id = '10721398'

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	The ID of the CustomTargetingKey. This value is readonly and is populated by Google.
Name	String	False	Name of the key. This can be used for encoding . If you don't want users to be able to see potentially sensitive targeting information in the ad tags of your site, you can encode your key/values. For example, you can create key/value g1=abc to represent gender=female. Keys can contain up to 10 characters each.
DisplayName	String	False	Descriptive name for the key.
Type	String	False	Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item. 使用できる値は次のとおりです。PREDEFINED, FREEFORM
Status	String	True	Status of the CustomTargetingKey. This field is read-only. A key can be activated and deactivated by calling CustomTargetingService.performCustomTargetingKeyAction. 使用できる値は次のとおりです。ACTIVE, INACTIVE, UNKNOWN
ReportableType	String	False	Reportable state of a {@CustomTargetingKey} as defined in ReportableType. 使用できる値は次のとおりです。UNKNOWN, ON, OFF, CUSTOM_DIMENSION

CustomTargetingValues

Create, update, and query DoubleClick for Publishers Custom Targeting Values.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of custom targeting values. For example:

SELECT * FROM [CustomTargetingValues] WHERE CustomTargetingKeyId IN (SELECT Id FROM [CustomTargetingKeys])

The CustomTargetingKeyId is required to execute a SELECT query.

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [CustomTargetingValues] WHERE CustomTargetingKeyId = '13684797' AND Id = '448574026142'

Insert

To create a new Custom Targeting Value, the CustomTargetingKeyId, and Name fields are required.

INSERT INTO [CustomTargetingValues] (CustomTargetingKeyId, Name) VALUES ('13684797', 'TestName')

Update

You can update the DisplayName only by specifying the CustomTargetingKeyId column (to update multiple values), and optionally the Id column (to update a specific value).

UPDATE [CustomTargetingValues] SET DisplayName = 'OtherValue' WHERE CustomTargetingKeyId = '13684797' AND Id = '448579390145'

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
CustomTargetingKeyId	Long	False	The ID of the CustomTargetingKey for which this is the value.
Id [KEY]	Long	True	The ID of the CustomTargetingValue. This value is readonly and is populated by Google.
Name	String	False	Name of the value. This can be used for encoding . If you don't want users to be able to see potentially sensitive targeting information in the ad tags of your site, you can encode your key/values. For example, you can create key/value g1=abc to represent gender=female. Values can contain up to 40 characters each.
DisplayName	String	False	Descriptive name for the value.
MatchType	String	False	The way in which the CustomTargetingValue.name strings will be matched. This match type can not be used within an audience segment rule. This match type can not be used within an audience segment rule. This match type can not be used within line item targeting. This match type can not be used within line item targeting. 使用できる値は次のとおりです。EXACT, BROAD, PREFIX, BROAD_PREFIX, SUFFIX, CONTAINS, UNKNOWN
Status	String	True	Status of the CustomTargetingValue. This field is read-only. A value can be activated and deactivated by calling CustomTargetingService.performCustomTargetingValueAction. 使用できる値は次のとおりです。ACTIVE, INACTIVE, UNKNOWN

Inventories

Create, update, and query DoubleClick for Publishers Inventories.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Inventories. For example:

SELECT * FROM [Inventories]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [Inventories] WHERE Id = '21619885919'

Insert

To create a new Inventory, the ParentId and Name fields are required. Additionally, you can also set Description and TargetWindow.

INSERT INTO [Inventories] (ParentId, Name, Description, TargetWindow) VALUES ('45429123', 'Ad_Unit_122', 'Ad unit description.', 'BLANK')

Update

You can update any field not marked as read-only by specifying the Id column.

UPDATE [Inventories] SET Name = 'NewAdUnitName' WHERE Id = '45429003'

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Uniquely identifies the AdUnit. This value is read-only and is assigned by Google when an ad unit is created. This attribute is required for updates.
ParentId	String	False	The ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. This attribute is required when creating the ad unit. Once the ad unit is created, this value will be read-only.
HasChildren	Boolean	True	This field is set to true if the ad unit has any children. This attribute is read-only and is populated by Google.
ParentPath	String	True	The path to this ad unit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty. This attribute is read-only and is populated by Google.
Name	String	False	The name of the ad unit. This attribute is required and its maximum length is 255 characters. This attribute must also be case-insensitive unique.
Description	String	False	A description of the ad unit. This value is optional and its maximum length is 65,535 characters.
TargetWindow	String	False	The value to use for the HTML link's target attribute. This value is optional and will be interpreted as TargetWindow. The default value is TOP. 使用できる値は次のとおりです。TOP, BLANK
Status	String	True	The status of this ad unit. It defaults to InventoryStatus.ACTIVE. This value cannot be updated directly using InventoryService.updateAdUnit. It can only be modified by performing actions via InventoryService.performAdUnitAction. 使用できる値は次のとおりです。ACTIVE, INACTIVE, ARCHIVED
AdUnitCode	String	False	A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based off of the inventory unit ID. Once an ad unit is created, its adUnitCode cannot be changed.
AdUnitSizes	String	False	The permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the sizes attribute.
IsInterstitial	Boolean	False	Whether this is an interstitial ad unit.
IsNative	Boolean	False	Whether this is a native ad unit.
IsFluid	Boolean	False	Whether this is a fluid ad unit.
ExplicitlyTargeted	Boolean	False	If this field is set to true, then the AdUnit will not be implicitly targeted when its parent is. Traffickers must explicitly target such an ad unit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.
AdSenseSettings	String	False	AdSense specific settings. To overwrite this, set the adSenseSettingsSource to PropertySourceType.DIRECTLY_SPECIFIED when setting the value of this field.
AdSenseSettingsSource	String	False	Specifies the source of adSenseSettings value. To revert an overridden value to its default, set this field to PropertySourceType.PARENT. 使用できる値は次のとおりです。PARENT, DIRECTLY_SPECIFIED, UNKNOWN
AppliedLabelFrequencyCaps	String	False	The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.
EffectiveLabelFrequencyCaps	String	True	Contains the set of labels applied directly to the ad unit as well as those inherited from parent ad units. This field is readonly and is assigned by Google.
AppliedLabels	String	True	The set of labels applied directly to this ad unit.
EffectiveAppliedLabels	String	True	Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.
EffectiveTeamIds	String	True	The IDs of all teams that this ad unit is on as well as those inherited from parent ad units. This value is read-only and is set by Google.
AppliedTeamIds	String	False	The IDs of all teams that this ad unit is on directly.
LastModifiedDateTime	Datetime	False	The date and time this ad unit was last modified.
SmartSizeMode	String	False	The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode.NONE for fixed sizes. 使用できる値は次のとおりです。UNKNOWN, NONE, SMART_BANNER, DYNAMIC_SIZE
RefreshRate	Int	False	The interval in seconds which ad units in mobile apps automatically refresh. Valid values are between 30 and 120 seconds. This attribute is optional and only applies to ad units in mobile apps. If this value is not set, then the mobile app ad will not refresh.
ExternalSetTopBoxChannelId	String	True	Specifies an ID for a channel in an external set-top box campaign management system. This attribute is only meaningful if isSetTopBoxEnabled is true. This attribute is read-only.
IsSetTopBoxEnabled	Boolean	True	Flag that specifies whether this ad unit represents an external set-top box channel. This attribute is read-only.
ApplicationId	Long	False	The MobileApplication.applicationId for the CTV application that this ad unit is within. This attribute is optional.

Labels

Create, update, delete, and query DoubleClick for Publishers Labels.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Labels. For example:

SELECT * FROM [Labels]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [Labels] WHERE Id = '370450571'

Insert

To create a new Label, the Name field is required.

INSERT INTO [Labels] (Name) VALUES ('new lbl')

Update

You can update any field not marked as read-only by specifying the Id column.

UPDATE [Labels] SET Description = 'New Description', Name = 'New updated lbl name' WHERE Id = '370341705'

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique ID of the Label. This value is readonly and is assigned by Google.
Name	String	False	Name of the Label. This value is required to create a label and has a maximum length of 127 characters.
Description	String	False	A description of the label. This value is optional and its maximum length is 255 characters.
IsActive	Boolean	True	Specifies whether or not the label is active. This attribute is read-only.
AdCategory	String	False	Indicates the Ad Category associated with the label.
Types	String	False	The types of the Label. 使用できる値は次のとおりです。COMPETITIVE_EXCLUSION, AD_UNIT_FREQUENCY_CAP, AD_EXCLUSION, CREATIVE_WRAPPER, CANONICAL_CATEGORY, UNKNOWN

LineItemCreativeAssociations

Query DoubleClick for Publishers LineItemCreativeAssociations.

Columns


Name	Type	ReadOnly	Description
LineItemId	Long	False	The ID of the LineItem to which the Creative should be associated. This attribute is required.
CreativeId	Long	False	The ID of the Creative object being associated with a LineItem. This attribute is required if this is an association between a line item and a creative. This attribute is ignored if this is an association between a line item and a creative set. If this is an association between a line item and a creative, when retrieving the line item creative association, the creativeId will be the creative's ID. If this is an association between a line item and a creative set, when retrieving the line item creative association, the creativeId will be the ID of the master creative.
CreativeSetId	Long	False	The ID of the CreativeSet being associated with a LineItem. This attribute is required if this is an association between a line item and a creative set. This field is null when retrieving associations between line items and creatives not belonging to a set.
ManualCreativeRotationWeight	Double	False	The weight of the Creative object. Only use this value if the line item's creativeRotationType is set to CreativeRotationType.MANUAL. This attribute is optional and defaults to 10.
SequentialCreativeRotationIndex	Int	False	The sequential rotation index of the Creative. Only use this attribute info the associated line item's LineItem.creativeRotationType is set to CreativeRotationType.SEQUENTIAL. This attribute is optional and defaults to 1.
StartDateTime	Datetime	False	Overrides the value set for LineItem.startDateTime. This attribute is optional and is only valid for Ad Manager 360 networks.
StartDateTimeType	String	False	Specifies whether to start serving to the LineItemCreativeAssociation right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME. 使用できる値は次のとおりです。USE_START_DATE_TIME, IMMEDIATELY, ONE_HOUR_FROM_NOW, UNKNOWN
EndDateTime	Datetime	False	Overrides LineItem.endDateTime. Setting this attribute is optional and is only valid for Ad Manager 360 networks.
DestinationUrl	String	False	Overrides the value set for HasDestinationUrlCreative.destinationUrl. This attribute is optional and is only valid for Ad Manager 360 networks.
Sizes	String	True	Overrides the value set for Creative.size. This attribute contains the aggregated data regarding the size of the creative object. Note that this returns an aggregate XML value. This attribute is optional and read-only. 使用できる値は次のとおりです。ACTIVE, NOT_SERVING, INACTIVE, UNKNOWN
Stats	String	True	Contains trafficking statistics for the association. This attribute is readonly and is populated by Google. This will be null in case there are no statistics for the association yet.
LastModifiedDateTime	Datetime	True	The date and time this association was last modified.
TargetingName	String	False	Specifies CreativeTargeting for this line item creative association. This attribute is optional. It should match the creative targeting specified on the corresponding CreativePlaceholder in the LineItem that is being associated with the Creative.

LineItems

Create, update, delete, and query DoubleClick for Publishers Line Items.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of LineItems. For example:

SELECT * FROM [LineItems]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [LineItems] WHERE Id = '4377540922'

Insert

To create a new LineItem, the following fields are required: OrderId, Name, LineItemType, CurrencyCode, MicroAmount, CostType, CreativePlaceholdersAggregate, GoalType, GoalUnits, and InventoryTargetingAggregate. Note that other columns could be required depending on data chosen for certain columns.

INSERT INTO [LineItems] (OrderId, Name, StartDateTimeType, EndDateTime, EndTimeZoneId, CreativeRotationType, LineItemType, CurrencyCode, MicroAmount, CostType, CreativePlaceholdersAggregate, AllowOverbook, GoalType, GoalUnitType, GoalUnits, GeoTargetingAggregate, InventoryTargetingAggregate) VALUES ('2108997295', 'line item 233', 'IMMEDIATELY', '2017-09-01', 'America/New_York', 'EVEN', 'STANDARD', 'USD', '200000', 'CPM', '<size><width>1</width><height>1</height><isAspectRatio>false</isAspectRatio></size><creativeTemplateId>10004520</creativeTemplateId><expectedCreativeCount>1</expectedCreativeCount><creativeSizeType>NATIVE</creativeSizeType>', 'true', 'LIFETIME', 'IMPRESSIONS', '500000', '<geoTargeting><targetedLocations><id>2840</id><type>COUNTRY</type><displayName>United States</displayName></targetedLocations><targetedLocations><id>20123</id><type>PROVINCE</type><canonicalParentId>2124</canonicalParentId><displayName>Quebec</displayName></targetedLocations><excludedLocations><id>1016367</id><type>CITY</type><canonicalParentId>21147</canonicalParentId><displayName>Chicago</displayName></excludedLocations><excludedLocations><id>200501</id><type>DMA_REGION</type><canonicalParentId>2840</canonicalParentId><displayName>New York NY</displayName></excludedLocations></geoTargeting>', '<inventoryTargeting><targetedPlacementIds>28544791</targetedPlacementIds></inventoryTargeting>')

Update

You can update any field not marked as read-only by specifying the Id column.

UPDATE [LineItems] SET DeliveryRateType = 'EVENLY' WHERE Id = '4377540922'

Delete

You can delete a LineItem row by specifying the Id column.

DELETE FROM [LineItems] WHERE Id = '4377865094'

Columns


Name	Type	ReadOnly	Description
OrderId	Long	False	The ID of the Order to which the LineItem belongs. This attribute is required.
Id [KEY]	Long	True	Uniquely identifies the LineItem. This attribute is read-only and is assigned by Google when a line item is created.
Name	String	False	The name of the line item. This attribute is required and has a maximum length of 255 characters.
ExternalId	String	False	An identifier for the LineItem that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
OrderName	String	True	The name of the Order. This value is read-only.
StartDateTime	Datetime	False	The date and time on which the LineItem is enabled to begin serving. This attribute is required unless LineItem.StartDateTimeType is set to IMMEDIATELY or ONE_HOUR_FROM_NOW.
StartTimeZoneId	String	False	The start date time timezone id of the LineItem. The timezone ID must be in tz database format (e.g. America/Los_Angeles).
StartDateTimeType	String	False	Specifies whether to start serving to the LineItem right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.
EndDateTime	Datetime	False	The date and time on which the LineItem will stop serving. This attribute is required unless LineItem.unlimitedEndDateTime is set to true. If specified, it must be after the LineItem.startDateTime. This end date and time does not include auto extension days.
EndTimeZoneId	String	False	The end date time timezone id of the LineItem. The timezone ID must be in tz database format (e.g. America/Los_Angeles).
AutoExtensionDays	Int	False	The number of days to allow a line item to deliver past its endDateTime. A maximum of 7 days is allowed. This feature is only available for Ad Manager 360 accounts.
UnlimitedEndDateTime	Bool	False	Specifies whether or not the LineItem has an end time. This attribute is optional and defaults to false. It can be be set to true for only line items of type LineItemType.SPONSORSHIP, LineItemType.NETWORK, LineItemType.PRICE_PRIORITY and LineItemType.HOUSE.
CreativeRotationType	String	False	The strategy used for displaying multiple Creative objects that are associated with the LineItem. This attribute is required.
DeliveryRateType	String	False	The strategy for delivering ads over the course of the line item's duration. This attribute is optional and defaults to DeliveryRateType.EVENLY or DeliveryRateType.FRONTLOADED depending on the network's configuration.
DeliveryForecastSource	String	False	Strategy for choosing forecasted traffic shapes to pace line items. This field is optional and defaults to DeliveryForecastSource.HISTORICAL.
CustomPacingCurve	String	False	The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is DeliveryForecastSource.CUSTOM_PACING_CURVE.
RoadblockingType	String	False	The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional and defaults to RoadblockingType.ONE_OR_MORE.
SkippableAdType	String	False	The nature of the line item's creatives' skippability. This attribute is optional, only applicable for video line items, and defaults to SkippableAdType.NOT_SKIPPABLE.
FrequencyCaps	String	False	The set of frequency capping units for this LineItem. This attribute is optional.
LineItemType	String	False	Indicates the line item type of a LineItem. This attribute is required. The line item type determines the default priority of the line item. More information can be found on the Ad Manager Help Center.
Priority	Int	False	The priority for the line item. Valid values range from 1 to 16. This field is optional and defaults to the default priority of the LineItemType. Each line item type has a default, minimum, and maximum priority value. This field can only be edited by certain networks, otherwise a PermissionError will occur.
CurrencyCode	String	False	Three letter currency code in string format.
MicroAmount	Long	False	Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
ValueCostPerUnit	String	False	An amount to help the adserver rank inventory. LineItem.valueCostPerUnit artificially raises the value of inventory over the LineItem.costPerUnit but avoids raising the actual LineItem.costPerUnit. This attribute is optional and defaults to a Money object in the local currency with Money.microAmount 0.
CostType	String	False	The method used for billing this LineItem. This attribute is required.
DiscountType	String	False	The type of discount being applied to a LineItem, either percentage based or absolute. This attribute is optional and defaults to LineItemDiscountType.PERCENTAGE.
Discount	Double	True	The number here is either a percentage or an absolute value depending on the LineItemDiscountType. If the LineItemDiscountType is LineItemDiscountType.PERCENTAGE, then only non-fractional values are supported.
ContractedUnitsBought	Long	True	This attribute is only applicable for certain line item types and acts as an 'FYI' or note, which does not impact adserving or other backend systems. For LineItemType.SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For LineItemType.STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a 'FYI' for traffickers to manually intervene with the LineItem when needed. This attribute is only available for LineItemType.STANDARD line items if you have this feature enabled on your network.
CreativePlaceholdersAggregate	String	False	Details about the creatives that are expected to serve through this LineItem. This attribute is required and replaces the creativeSizes attribute.
ActivityAssociations	String	False	This attribute is required and meaningful only if the LineItem.costType is CostType.CPA.
EnvironmentType	String	False	The environment that the LineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.
AllowedFormats	String	False	The set of allowedFormats that this programmatic line item can have. If the set is empty, this line item allows all formats.
CompanionDeliveryOption	String	False	The delivery option for companions. Setting this field is only meaningful if the following conditions are met: the Guaranteed roadblocks feature is enabled on your network, and environmentType is EnvironmentType.VIDEO_PLAYER or roadblockingType is RoadblockingType.CREATIVE_SET. This field is optional and defaults to CompanionDeliveryOption.OPTIONAL if the conditions are met. In all other cases it defaults to CompanionDeliveryOption.UNKNOWN and is not meaningful.
AllowOverbook	Bool	False	The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types LineItemType.SPONSORSHIP and LineItemType.STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field will not persist on the line item itself, and the value will only affect the current request.
SkipInventoryCheck	Bool	False	The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field will not persist on the line item itself, and the value will only affect the current request.
SkipCrossSellingRuleWarningChecks	Bool	False	True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false.
ReserveAtCreation	Bool	False	The flag indicates whether inventory should be reserved when creating a line item of types LineItemType.SPONSORSHIP and LineItemType.STANDARD in an unapproved Order. The default value is false.
Stats	String	True	Contains trafficking statistics for the line item. This attribute is readonly and is populated by Google. This will be null in case there are no statistics for a line item yet.
DeliveryIndicator	String	True	Indicates how well the line item has been performing. This attribute is readonly and is populated by Google. This will be null if the delivery indicator information is not available due to one of the following reasons: The line item is not delivering, has an unlimited goal or cap or has a percentage based goal or cap.
DeliveryData	String	True	Delivery data provides the number of clicks or impressions delivered for a LineItem in the last 7 days. This attribute is readonly and is populated by Google. This will be null if the delivery data cannot be computed due to one of the following reasons: The line item is not deliverable, has completed delivering more than 7 days ago or has an absolute-based goal.
Budget	String	True	The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.
Status	String	True	The status of the LineItem. This attribute is readonly.
ReservationStatus	String	True	Describes whether or not inventory has been reserved for the LineItem. This attribute is readonly and is assigned by Google.
IsArchived	Bool	True	The archival status of the LineItem. This attribute is readonly.
WebPropertyCode	String	False	The web property code used for dynamic allocation line items. This web property is only required with line item types LineItemType.AD_EXCHANGE and LineItemType.ADSENSE.
AppliedLabels	String	False	The set of labels applied directly to this line item.
EffectiveAppliedLabels	String	True	Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.
DisableSameAdvertiserCompetitiveExclusion	Bool	False	If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.
LastModifiedByApp	String	True	The application that last modified this line item. This attribute is read only and is assigned by Google.
Notes	String	False	Provides any additional notes that may annotate the LineItem. This attribute is optional and has a maximum length of 65,535 characters.
CompetitiveConstraintScope	String	False	The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field is optional, defaults to CompetitiveConstraintScope.POD, and only applies to video line items.
LastModifiedDateTime	Datetime	True	The date and time this line item was last modified.
CreationDateTime	Datetime	True	This attribute may be null for line items created before this feature was introduced.
IsMissingCreatives	Bool	True	Indicates if a LineItem is missing any creatives for the creativePlaceholders specified. Creatives can be considered missing for several reasons including: Not enough creatives of a certain size have been uploaded or The Creative.appliedLabels of an associated Creative do not match the CreativePlaceholder.effectiveAppliedLabels of the LineItem.
ProgrammaticCreativeSource	String	False	Indicates the ProgrammaticCreativeSource of the programmatic line item. This is a read-only field. Any changes must be made on the ProposalLineItem.
ThirdPartyMeasurementSettings	String	False
YoutubeKidsRestricted	Bool	False	Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the Ad Manager Help Center for more information.
VideoMaxDuration	Long	True	The max duration of a video creative associated with this LineItem in milliseconds. This attribute is only meaningful for video line items. For version v202011 and earlier, this attribute is optional and defaults to 0. For version v202102 and later, this attribute is required for video line items and must be greater than 0.
GoalType	String	False	The type of the goal for the LineItem. It defines the period over which the goal for LineItem should be reached.
GoalUnitType	String	False	The type of the goal unit for the LineItem.
GoalUnits	Int	False	If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the LineItem.
SecondaryGoals	String	False	The secondary goals that this LineItem is associated with. It is required and meaningful only if the LineItem.costType is CostType.CPA or if the LineItem.lineItemType is LineItemType.SPONSORSHIP and LineItem.costType is CostType.CPM.
GrpSettings	String	False	Contains the information for a line item which has a target GRP demographic.
DealInfo	String	False	The deal information associated with this line item, if it is programmatic.
ViewabilityProviderCompanyIds	String	False	Optional IDs of the Company that provide ad verification for this line item. Company.Type.VIEWABILITY_PROVIDER.
ChildContentEligibility	String	True	Child content eligibility designation for this line item. This field is optional and defaults to ChildContentEligibility.DISALLOWED.
CustomVastExtension	String	True	Custom XML to be rendered in a custom VAST response at serving time.
GeoTargetingAggregate	String	False	Specifies what geographical locations are targeted by the LineItem. This attribute is optional.
InventoryTargetingAggregate	String	False	Specifies what inventory is targeted by the LineItem. This attribute is required. The line item must target at least one ad unit or placement.
CustomTargetingAggregate	String	False	Specifies the collection of custom criteria that is targeted by the LineItem.
CreativeTargetings	String	False	A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a creative placeholder's CreativePlaceholder.targetingName field by referencing the creative targeting's name. It also needs to be re-specified in the LineItemCreativeAssociation.targetingName field when associating a line item with a creative that fits into that placeholder.
CustomFieldName	String	True	This is the name of the custom field. There will be as many custom columns as custom fields are related to LineItems.

MobileApplications

Create and query DoubleClick for Publishers Mobile Applications.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of MobileApplications. For example:

SELECT * FROM [MobileApplications]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [MobileApplications] WHERE Id = '370450571'

Insert

To create a new MobileApplication, the DisplayName, AppStoreId, and AppStores fields are required.

INSERT INTO [MobileApplications] (DisplayName, AppStoreId, AppStores) VALUES ('Netflix', 'com.netflix.mediaclient', 'GOOGLE_PLAY')

Update

The UPDATE operation is not supported for this table.

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Uniquely identifies the mobile application. This attribute is read-only and is assigned by Google when a mobile application is claimed.
ApplicationId	Long	True	Uniquely identifies the mobile application. This attribute is read-only and is assigned by Google when a mobile application is claimed. The id field is being deprecated in favor of this new ID space.
DisplayName	String	False	The display name of the mobile application. This attribute is required and has a maximum length of 255 characters.
AppStoreId	String	False	The app store ID of the app to claim. This attribute is required for creation and then is read-only.
AppStores	String	False	The app stores the mobile application belongs to. This attribute is required for creation and is mutable to allow for third party app store linking. Possible values include APPLE_ITUNES, GOOGLE_PLAY, ROKU, AMAZON_FIRETV, PLAYSTATION, XBOX, SAMSUNG_TV, AMAZON_APP_STORE, OPPO_APP_STORE, SAMSUNG_APP_STORE, VIVO_APP_STORE, and XIAOMI_APP_STORE.
IsArchived	Boolean	True	The archival status of the mobile application. This attribute is read-only.
AppStoreName	String	True	The name of the application on the app store. This attribute is read-only and populated by Google.
ApplicationCode	String	True	The application code used to identify the app in the SDK. This attribute is read-only and populated by Google. Note that the UI refers to this as 'App ID'.
DeveloperName	String	True	The name of the developer of the mobile application. This attribute is read-only and populated by Google.
Platform	String	True	The platform the mobile application runs on. This attribute is read-only and populated by Google. 使用できる値は次のとおりです。UNKNOWN, ANDROID, IOS, ROKU, AMAZON_FIRETV, PLAYSTATION, XBOX, SAMSUNG_TV
IsFree	Boolean	True	Whether the mobile application is free on the app store it belongs to. This attribute is read-only and populated by Google.
DownloadUrl	String	True	The download URL of the mobile application on the app store it belongs to. This attribute is read-only and populated by Google.

Orders

Create, update, delete, and query DoubleClick for Publishers Orders.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Orders. For example:

SELECT * FROM [ Orders ]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [Orders] WHERE Id = '2112977260'

Insert

To create a new Order, the Name, AdvertiserId, and TraffickerId fields are required.

INSERT INTO [Orders] (Name, AdvertiserId, TraffickerId) VALUES ('Ord313', '4410125029', '244525926')

Update

You can update the Notes of an Order row by specifying the Id column.

UPDATE [Orders] SET Notes = 'Updated notes22222' WHERE Id = '2112977260'

Delete

You can delete an Order row by specifying the Id column.

DELETE FROM [Orders] WHERE Id = '2108997295'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	False	The unique ID of the Order. This value is readonly and is assigned by Google.
Name	String	False	The name of the Order. This value is required to create an order and has a maximum length of 255 characters.
StartDateTime	Datetime	True	The date and time at which the Order and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest LineItem.startDateTime.
EndDateTime	Datetime	True	The date and time at which the Order and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest LineItem.endDateTime.
UnlimitedEndDateTime	Bool	False	Specifies whether or not the Order has an unlimited end date. This attribute is readonly and is true if any of the order's line items has LineItem.unlimitedEndDateTime set to true.
Status	String	True	The status of the Order. This attribute is read-only.
IsArchived	Bool	False	The archival status of the Order. This attribute is readonly.
Notes	String	False	Provides any additional notes that may annotate the Order. This attribute is optional and has a maximum length of 65,535 characters.
ExternalOrderId	Int	False	An arbitrary ID to associate to the Order, which can be used as a key to an external system. This value is optional.
PoNumber	String	False	The purchase order number for the Order. This value is optional and has a maximum length of 63 characters.
CurrencyCode	String	True	The ISO currency code for the currency used by the Order. This value is read-only and is the network's currency code.
AdvertiserId	Long	False	The unique ID of the Company, which is of type Company.Type.ADVERTISER, to which this order belongs. This attribute is required.
AdvertiserContactIds	String	False	List of IDs for advertiser contacts of the order.
AgencyId	Long	False	The unique ID of the Company, which is of type Company.Type.AGENCY, with which this order is associated. This attribute is optional.
AgencyContactIds	String	False	List of IDs for agency contacts of the order.
CreatorId	Long	True	The unique ID of the User who created the Order on behalf of the advertiser. This value is readonly and is assigned by Google.
TraffickerId	Long	False	The unique ID of the User responsible for trafficking the Order. This value is required for creating an order
SecondaryTraffickerIds	String	False	The IDs of the secondary traffickers associated with the order. This value is optional.
SalespersonId	Long	False	The unique ID of the User responsible for the sales of the Order. This value is optional.
SecondarySalespersonIds	String	False	The IDs of the secondary salespeople associated with the order. This value is optional.
TotalImpressionsDelivered	Long	True	Total impressions delivered for all line items of this Order. This value is read-only and is assigned by Google.
TotalClicksDelivered	Long	True	Total clicks delivered for all line items of this Order. This value is read-only and is assigned by Google.
TotalViewableImpressionsDelivered	Long	True	Total viewable impressions delivered for all line items of this Order. This value is read-only and is assigned by Google. Starting in v201705, this will be null when the order does not have line items trafficked against a viewable impressions goal.
TotalBudget	String	False	Total budget for all line items of this Order. This value is a readonly field assigned by Google and is calculated from the associated LineItem.costPerUnit values.
AppliedLabels	String	False	The set of labels applied directly to this order.
EffectiveAppliedLabels	String	True	Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.
LastModifiedByApp	String	True	The application which modified this order. This attribute is read only and is assigned by Google.
IsProgrammatic	Bool	False	Specifies whether or not the Order is a programmatic order. This value is optional and defaults to false.
AppliedTeamIds	String	False	The IDs of all teams that this order is on directly.
LastModifiedDateTime	Datetime	True	The date and time this order was last modified.
CustomFieldName	String	True	This is the name of the custom field. There will be as many custom columns as custom fields are related to Orders.

Placements

Create, update, delete, and query DoubleClick for Publishers Placements.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Placements. For example:

SELECT * FROM [Placements]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [Placements] WHERE Id = '28544791'

Insert

To create a new Placement, the Name, and TargetedAdUnitIds fields are required.

INSERT INTO [Placements] (Name, TargetedAdUnitIds ) VALUES ('placement', '21622217303, 21622217300')

Update

You can update any field not marked as read-only by specifying the Id column.

UPDATE [Placements] SET Name = 'New Placement', Description = 'New Description' WHERE Id = '28544791'

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Uniquely identifies the Placement. This attribute is read-only and is assigned by Google when a placement is created.
Name	String	False	The name of the Placement. This value is required and has a maximum length of 255 characters.
Description	String	False	A description of the Placement. This value is optional and its maximum length is 65,535 characters.
PlacementCode	String	True	A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.
Status	String	True	The status of the Placement. This attribute is read-only. 使用できる値は次のとおりです。ACTIVE, INACTIVE, ARCHIVED
TargetedAdUnitIds	String	False	The collection of AdUnit object IDs that constitute the Placement.
LastModifiedDateTime	Datetime	True	The date and time this placement was last modified.

ProposalLineItems

Create, update, and query DoubleClick for Publishers ProposalLineItems.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	The unique ID of the ProposalLineItem. This attribute is read-only.
ProposalId	Long	False	The unique ID of the Proposal, to which the ProposalLineItem belongs. This attribute is required for creation and then is readonly.
Name	String	False	The name of the ProposalLineItem which should be unique under the same Proposal. This attribute has a maximum length of 255 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
StartDateTime	Datetime	False	The date and time at which the line item associated with the ProposalLineItem is enabled to begin serving. This attribute is optional during creation, but required and must be in the future when it turns into a line item. The DateTime.timeZoneID is required if start date time is not null. This attribute becomes readonly once the ProposalLineItem has started delivering.
EndDateTime	Datetime	False	The date and time at which the line item associated with the ProposalLineItem stops beening served. This attribute is optional during creation, but required and must be after the startDateTime. The DateTime.timeZoneID is required if end date time is not null.
TimeZoneId	String	False	The time zone ID in tz database format (e.g. 'America/Los_Angeles') for this ProposalLineItem. The number of serving days is calculated in this time zone. So if rateType is RateType.CPD, it will affect the cost calculation. The startDateTime and endDateTime will be returned in this time zone. This attribute is optional and defaults to the network's time zone. This attribute is read-only when using programmatic guaranteed, using sales management, or when using programmatic guaranteed, not using sales management.
InternalNotes	String	False	Provides any additional notes that may annotate the ProposalLineItem. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
IsArchived	Boolean	True	The archival status of the ProposalLineItem. This attribute is read-only.
Goal	String	False	The goal (i.e. contracted quantity, quantity or limit) that this ProposalLineItem is associated with, which is used in its pacing and budgeting. Goal.units must be greater than 0 when the proposal line item turns into a line item, Goal.goalType and Goal.unitType are readonly. For a Preferred deal ProposalLineItem, the goal type can only be GoalType.NONE.
SecondaryGoals	String	False	The secondary goals that this ProposalLineItem is associated with. For a programmatic line item with the properties RateType.CPM and LineItemType.SPONSORSHIP, this field will have one goal which describes the impressions cap. For other cases, this field is an empty list.
ContractedUnitsBought	Long	False	The contracted number of impressions or clicks. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is false, then this represents the lifetime minimum impression. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is true, then this represents the daily minimum impression. This attribute is required for percentage-based-goal proposal line items. It does not impact ad-serving and is for reporting purposes only.
DeliveryRateType	String	False	The strategy for delivering ads over the course of the ProposalLineItem's duration. This attribute is required. For a Preferred deal ProposalLineItem, the value can only be DeliveryRateType.FRONTLOADED. 使用できる値は次のとおりです。EVENLY, FRONTLOADED, AS_FAST_AS_POSSIBLE
RoadblockingType	String	False	The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional during creation and defaults to the product's roadblocking type, or RoadblockingType.ONE_OR_MORE if not specified by the product. 使用できる値は次のとおりです。ONLY_ONE, ONE_OR_MORE, AS_MANY_AS_POSSIBLE, ALL_ROADBLOCK, CREATIVE_SET
CompanionDeliveryOption	String	False	The delivery option for companions. This is only valid if the roadblocking type is RoadblockingType.CREATIVE_SET. The default value for roadblocking creatives is CompanionDeliveryOption.OPTIONAL. The default value in other cases is CompanionDeliveryOption.UNKNOWN. Providing something other than CompanionDeliveryOption.UNKNOWN will cause an error. 使用できる値は次のとおりです。OPTIONAL, AT_LEAST_ONE, ALL, UNKNOWN
VideoMaxDuration	Long	False	The max duration of a video creative associated with this ProposalLineItem in milliseconds. This attribute is optional, defaults to the Product.videoMaxDuration on the Product it was created with, and only meaningful if this is a video proposal line item.
VideoCreativeSkippableAdType	String	False	The proposal line item's creatives' skippability. This attribute is optional, only applicable for video proposal line items, and defaults to SkippableAdType.NOT_SKIPPABLE. 使用できる値は次のとおりです。UNKNOWN, DISABLED, ENABLED, INSTREAM_SELECT, ANY
FrequencyCaps	String	False	The set of frequency capping units for this ProposalLineItem. This attribute is optional during creation and defaults to the product's frequency caps if Product.allowFrequencyCapsCustomization is false.
DfpLineItemId	Long	True	The unique ID of the corresponding LineItem. This will be null if the Proposal has not been pushed to Ad Manager. This attribute is read-only.
LineItemType	String	False	The corresponding LineItemType of the ProposalLineItem. For a programmatic ProposalLineItem, the value can only be one of: 使用できる値は次のとおりです。SPONSORSHIP, STANDARD, NETWORK, BULK, PRICE_PRIORITY, HOUSE, LEGACY_DFP, CLICK_TRACKING, ADSENSE, AD_EXCHANGE, BUMPER, ADMOB, PREFERRED_DEAL, UNKNOWN
LineItemPriority	Int	False	The priority for the corresponding LineItem of the ProposalLineItem. This attribute is optional during creation and defaults to the default priority of the lineItemType. For forecasting, this attribute is optional and has a default value assigned by Google. See LineItem.priority for more information.
RateType	String	False	The method used for billing the ProposalLineItem. 使用できる値は次のとおりです。CPM, CPC, CPD, CPU, FLAT_FEE, VCPM, CPM_IN_TARGET, UNKNOWN
CreativePlaceholders	String	False	Details about the creatives that are expected to serve through the ProposalLineItem. This attribute is optional during creation and defaults to the product's creative placeholders.
Targeting	String	False	Contains the targeting criteria for the ProposalLineItem. This attribute is optional during creation and defaults to the product's targeting.
AppliedLabels	String	False	The set of labels applied directly to the ProposalLineItem. This attribute is optional.
EffectiveAppliedLabels	String	True	Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only.
DisableSameAdvertiserCompetitiveExclusion	Boolean	False	If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied. This attribute is optional and defaults to false.
IsSold	Boolean	True	Indicates whether this ProposalLineItem has been sold. This attribute is read-only.
NetRate	String	False	The amount of money to spend per impression or click in proposal currency. It supports precision of 4 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 100. It doesn't include agency commission. For example, if Proposal.currencyCode is 'USD', then $123.4567 could be represented as 123456700, but further precision is not supported. At least one of the two fields ProposalLineItem.netRate and ProposalLineItem.netCost is required.
NetCost	String	False	The cost of the ProposalLineItem in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 10000. It doesn't include agency commission. For example, if Proposal.currencyCode is 'USD', then $123.45 could be represented as 123450000, but further precision is not supported. At least one of the two fields ProposalLineItem.netRate and ProposalLineItem.netCost is required.
DeliveryIndicator	String	False	Indicates how well the line item generated from this proposal line item has been performing. This will be null if the delivery indicator information is not available due to one of the following reasons:
DeliveryData	String	False	Delivery data provides the number of clicks or impressions delivered for the LineItem generated from this proposal line item in the last 7 days. This will be null if the delivery data cannot be computed due to one of the following reasons: 1) The proposal line item has not pushed to Ad Manager. 2) The line item is not deliverable. 3) The line item has completed delivering more than 7 days ago. 4) The line item has an absolute-based goal. ProposalLineItem.deliveryIndicator should be used to track its progress in this case.
ComputedStatus	String	True	The status of the LineItem generated from this proposal line item. This will be null if the proposal line item has not pushed to Ad Manager. This attribute is read-only. 使用できる値は次のとおりです。DELIVERY_EXTENDED, DELIVERING, READY, PAUSED, INACTIVE, PAUSED_INVENTORY_RELEASED, PENDING_APPROVAL, COMPLETED, DISAPPROVED, DRAFT, CANCELED
LastModifiedDateTime	Datetime	True	The date and time this ProposalLineItem was last modified. This attribute is assigned by Google when a ProposalLineItem is updated. This attribute is read-only.
ReservationStatus	String	True	The reservation status of the ProposalLineItem. This attribute is read-only. 使用できる値は次のとおりです。RESERVED, NOT_RESERVED, RELEASED, CHECK_LINE_ITEM_RESERVATION_STATUS, UNKNOWN
LastReservationDateTime	Datetime	True	The last DateTime when the ProposalLineItem reserved inventory. This attribute is read-only.
EnvironmentType	String	True	The environment that the ProposalLineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then this ProposalLineItem can only target ad units that have sizes whose AdUnitSize.environmentType is also EnvironmentType.VIDEO_PLAYER. This field is read-only and set to Product.environmentType of the product this proposal line item was created from. 使用できる値は次のとおりです。BROWSER, VIDEO_PLAYER
AllowedFormats	String	False	The set of AllowedFormats that this proposal line item can have. If the set is empty, this proposal line item allows all formats. 使用できる値は次のとおりです。AUDIO, UNKNOWN
IsProgrammatic	Boolean	True	Whether or not the Proposal for this ProposalLineItem is a programmatic deal. This attribute is populated from Proposal.isProgrammatic. This attribute is read-only.
AdditionalTerms	String	False	Additional terms shown to the buyer in Marketplace.
ProgrammaticCreativeSource	String	False	Indicates the ProgrammaticCreativeSource of the programmatic line item. 使用できる値は次のとおりです。PUBLISHER, ADVERTISER, UNKNOWN
GrpSettings	String	False	Contains the information for a proposal line item which has a target GRP demographic.
EstimatedMinimumImpressions	Long	False	The estimated minimum impressions that should be delivered for a proposal line item.
ThirdPartyMeasurementSettings	String	False	Contains third party measurement settings for cross-sell Partners.
MakegoodInfo	String	False	Makegood info for this proposal line item. Immutable once created. Null if this proposal line item is not a makegood.
HasMakegood	Boolean	True	Whether this proposal line item has an associated makegood. This attribute is read-only.
CanCreateMakegood	Boolean	True	Whether a new makegood associated with this line item can be created. This attribute is read-only.
PauseRole	String	True	The NegotiationRole that paused the proposal line item, i.e. NegotiationRole.seller or NegotiationRole.buyer, or null when the proposal is not paused. This attribute is read-only. 使用できる値は次のとおりです。BUYER, SELLER, UNKNOWN
PauseReason	String	True	The reason for pausing the ProposalLineItem, provided by the pauseRole. It is null when the ProposalLineItem is not paused. This attribute is read-only.

Proposals

Create, update, and query DoubleClick for Publishers Proposals.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	The unique ID of the Proposal. This attribute is read-only.
IsProgrammatic	Boolean	False	Flag that specifies whether this Proposal is for programmatic deals. This value is default to false.
DfpOrderId	Long	True	The unique ID of the corresponding Order. This will be null if the Proposal has not been pushed to Ad Manager. This attribute is read-only.
Name	String	False	The name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.name when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
StartDateTime	Datetime	True	The date and time at which the order and line items associated with the Proposal are eligible to begin serving. This attribute is derived from the proposal line item of the proposal which has the earliest ProposalLineItem.startDateTime. This attribute will be null, if this proposal has no related line items, or none of its line items have a start time. This attribute is read-only.
EndDateTime	Datetime	True	The date and time at which the order and line items associated with the Proposal stop being served. This attribute is derived from the proposal line item of the proposal which has the latest ProposalLineItem.endDateTime. This attribute will be null, if this proposal has no related line items, or none of its line items have an end time. This attribute is read-only.
Status	String	True	The status of the Proposal. This attribute is read-only. 使用できる値は次のとおりです。DRAFT, PENDING_APPROVAL, APPROVED, REJECTED, UNKNOWN
IsArchived	Boolean	True	The archival status of the Proposal. This attribute is read-only.
Advertiser	String	False	The advertiser, to which this Proposal belongs, and a set of Contact objects associated with the advertiser. The ProposalCompanyAssociation.type of this attribute should be ProposalCompanyAssociationType.ADVERTISER. This attribute is required when the proposal turns into an order, and its ProposalCompanyAssociation.companyId will be copied to Order.advertiserId. This attribute becomes readonly once the Proposal has been pushed.
Agencies	String	False	List of agencies and the set of Contact objects associated with each agency. This attribute is optional. A Proposal only has at most one Company with ProposalCompanyAssociationType.PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If primary agency exists, its ProposalCompanyAssociation.companyId will be copied to Order.agencyId when the proposal turns into an order.
InternalNotes	String	False	Provides any additional notes that may annotate the Proposal. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
PrimarySalesperson	String	False	The primary salesperson who brokered the transaction with the advertiser. This attribute is required when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
SalesPlannerIds	Long	False	List of unique IDs of the User objects who are the sales planners of the Proposal. This attribute is optional. A proposal can have 8 sales planners at most. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
PrimaryTraffickerId	Long	False	The unique ID of the User who is the primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to Order.primaryTraffickerId . This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
SellerContactIds	Long	False	Users who are the seller's contacts.
AppliedTeamIds	Long	False	The IDs of all teams that the Proposal is on directly. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
AppliedLabels	String	False	The set of labels applied directly to the Proposal. This attribute is optional.
EffectiveAppliedLabels	String	True	Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only.
CurrencyCode	String	False	The currency code of this Proposal. This attribute is optional and defaults to network's currency code.
IsSold	Boolean	True	Indicates whether the proposal has been sold, i.e., corresponds to whether the status of an Order is OrderStatus.APPROVED or OrderStatus.PAUSED. This attribute is read-only.
LastModifiedDateTime	Datetime	True	The date and time this Proposal was last modified. This attribute is read-only.
MarketplaceInfo	String	False	The marketplace info of this proposal if it has a corresponding order in Marketplace.
BuyerRfp	String	False	The buyer RFP associated with this Proposal, which is optional. This field will be null if the proposal is not initiated from RFP.
HasBuyerRfp	Boolean	False	Whether a Proposal contains a BuyerRfp field. If this field is true, it indicates that the Proposal in question orignated from a buyer.
DeliveryPausingEnabled	Boolean	False	Whether pausing is consented for the Proposal. This field is optional and defaults to true. If false, it indicates that the buyer and the seller agree that the proposal should not be paused.

Users

Create, update, delete, and query DoubleClick for Publishers Users.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Users. For example:

SELECT * FROM [Users]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [Users] WHERE Id = '244555723'

Insert

To create a new User, the Name, Email, and RoleId fields are required.

INSERT INTO [Users] (Name, Email, RoleId ) VALUES ('murat', '[email protected]', '-1')

Update

You can update any column not marked as read-only by specifying the Id column.

UPDATE [Users] SET Name = 'New User' WHERE Id = '244555723'

Delete

You can delete a User row by specifying the Id column.

DELETE FROM [Users] WHERE Id = '244555723'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	The unique ID of the User. This attribute is readonly and is assigned by Google.
Name	String	False	The name of the User. It has a maximum length of 128 characters.
Email	String	False	The email or login of the User. In order to create a new user, you must already have a Google Account.
RoleId	Long	False	The unique role ID of the User. Roles that are created by Google will have negative IDs.
RoleName	String	True	The name of the role assigned to the User. This attribute is readonly.
IsActive	Boolean	True	Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations. This attribute is read-only.
IsEmailNotificationAllowed	Boolean	False	Specifies whether or not the User wants to permit the Publisher Display Ads system to send email notifications to their email address. This attribute is optional and defaults to true.
ExternalId	String	False	An identifier for the User that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
IsServiceAccount	Boolean	True	Whether the user is an OAuth2 service account user. This attribute is read-only. Service account users can only be added through the UI.
OrdersUiLocalTimeZoneId	String	False	The long format timezone id (e.g. 'America/Los_Angeles') used in the orders and line items UI for this User. Set this to null to indicate that no such value is defined for the User - UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not in particular affect the timezone of any dates and times returned in API responses.

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Google Ad Manager Connector for CData Sync ビュー


Name	Description
DeliveryReport	Query DoubleClick for Publishers Delivery Reports.
InventoryReport	A template inventory report.
Roles	Query DoubleClick for Publishers Roles.
SalesReport	A template sales report.

DeliveryReport

Query DoubleClick for Publishers Delivery Reports.

Select

Represents a report job that will be run to retrieve performance and statistics information about deliveries. By default, the report will retrieve data for the last month. Specify StartDate and EndDate to run the report on the desired time period. For example:

SELECT * FROM [DeliveryReport] WHERE StartDate = '01-01-2018' AND EndDate = '01-02-2018'

Columns


Name	Type	Description
OrderId	String	The unique ID of the Order. This value is read-only and is assigned by Google.
OrderName	String	The name of the Order. This value is required to create an Order and has a maximum length of 255 characters.
AdServerImpressions	Long	The number of impressions delivered by the ad server. Corresponds to 'Ad server impressions' in the Ad Manager UI. Compatible with the 'Historical' report type.
AdServerClicks	Long	The number of clicks delivered by the ad server. Corresponds to 'Ad server clicks' in the Ad Manager UI. Compatible with the 'Historical' report type.
AdServerCtr	Double	The CTR for an ad delivered by the ad server. Corresponds to 'Ad server CTR' in the Ad Manager UI. Compatible with the 'Historical' report type.
AdServerCpmAndCpcRevenue	Long	The CPM and CPC revenue earned, calculated in publisher currency, for the ads delivered by the ad server.Corresponds to 'Ad server CPM and CPC revenue' in the Ad Manager UI. Compatible with the 'Historical' report type.
AdServerWithoutCpdAverageEcpm	Double	The average estimated cost-per-thousand-impressions earned from the CPM and CPC ads delivered by the ad server. Corresponds to 'Ad server average eCPM' in the Ad Manager UI. Compatible with the 'Historical' report type.
OrderTrafficker	String	The name and email address in the form of name (email) of the trafficker for Dimension.ORDER_NAME. Corresponds to 'Trafficker' in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.
OrderStartDateTime	Datetime	Represents the start date (in YYYY-MM-DD format) for Dimension.ORDER_NAME. Corresponds to 'Order start date' in the Ad Manager UI.
OrderEndDateTime	Datetime	Represents the end date (in YYYY-MM-DD format) for Dimension.ORDER_NAME. Corresponds to 'Order end date' in the Ad Manager UI.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
EndDate	Date	The end date of the custom date range. The end date cannot be later than today's date.
StartDate	Date	The start date of the custom date range. The start date must be earlier than or the same as the end date.
DateRangeType	String	The period of time for which the reporting data is being generated. Supported values are: TODAY, YESTERDAY, LAST_WEEK, LAST_MONTH, LAST_3_MONTHS, REACH_LIFETIME, CUSTOM_DATE, NEXT_DAY, NEXT_90_DAYS, NEXT_WEEK, NEXT_MONTH, CURRENT_AND_NEXT_MONTH, NEXT_QUARTER, NEXT_3_MONTHS, NEXT_12_MONTHS. In order to define custom time periods, set this to CUSTOM_DATE.

InventoryReport

A template inventory report.

Select

Represents a report job that will be run to retrieve performance and statistics information about inventories. By default, the report will retrieve data for the last month. Specify StartDate and EndDate to run the report on the desired time period. For example:

SELECT * FROM [InventoryReport] WHERE StartDate = '01-01-2018' AND EndDate = '01-02-2018'

Columns


Name	Type	Description
AdUnitId	String	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdUnitName	String	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerImpressions	Long	The number of impressions delivered by the ad server.
AdServerClicks	Long	The number of clicks delivered by the ad server.
AdExchangeLineItemLevelImpressions	Long	The number of impressions an Ad Exchange ad delivered for line item-level dynamic allocation.
AdExchangeLineItemLevelClicks	Long	The number of clicks an Ad Exchange ad delivered for line item-level dynamic allocation.
TotalLineItemLevelImpressions	Long	The total number of impressions delivered including line item-level dynamic allocation.
TotalLineItemLevelCPMAndCPCRevenue	Long	The total CPM and CPC revenue generated by the ad servers including line item-level dynamic allocation.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
EndDate	Date	The end date of the custom date range. The end date cannot be later than today's date.
StartDate	Date	The start date of the custom date range. The start date must be earlier than or the same as the end date.
DateRangeType	String	The period of time for which the reporting data is being generated. Supported values are: TODAY, YESTERDAY, LAST_WEEK, LAST_MONTH, LAST_3_MONTHS, REACH_LIFETIME, CUSTOM_DATE, NEXT_DAY, NEXT_90_DAYS, NEXT_WEEK, NEXT_MONTH, CURRENT_AND_NEXT_MONTH, NEXT_QUARTER, NEXT_3_MONTHS, NEXT_12_MONTHS. In order to define custom time periods, set this to CUSTOM_DATE

Roles

Query DoubleClick for Publishers Roles.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Roles. For example:

SELECT * FROM [Roles]

Additionally, you can specify the Id or filter by any other column.

SELECT * FROM [Roles] WHERE Id = '-28'

Columns


Name	Type	Description
Id [KEY]	Long	The unique ID of the role. This value is readonly and is assigned by Google. Roles that are created by Google will have negative IDs.
Name	String	The name of the role. This value is readonly and is assigned by Google.
Description	String	The description of the role. This value is readonly and is assigned by Google.
Status	String	The status of the Role. This field is read-only and can have the values RoleStatus.ACTIVE (default) or RoleStatus.INACTIVE, which determines the visibility of the role in the UI. 使用できる値は次のとおりです。ACTIVE, INACTIVE, UNKNOWN

SalesReport

A template sales report.

Select

Represents a report job that will be run to retrieve performance and statistics information about sales. By default, the report will retrieve data for the last month. Specify StartDate and EndDate to run the report on the desired time period. For example:

SELECT * FROM [SalesReport] WHERE StartDate = '01-01-2018' AND EndDate = '01-02-2018'

Columns


Name	Type	Description
SalesPersonId	String	Breaks down reporting data by salesperson User.id.
SalesPersonName	String	Breaks down reporting data by salesperson.
AdServerImpressions	Long	The number of impressions delivered by the ad server.
AdServerCpmAndCpcRevenue	Long	The CPM and CPC revenue earned, calculated in publisher currency, for the ads delivered by the ad server.
AdServerWithoutCpdAverageEcpm	Long	The average estimated cost-per-thousand-impressions earned from the CPM and CPC ads delivered by the ad server.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
EndDate	Date	The end date of the custom date range. The end date cannot be later than today's date.
StartDate	Date	The start date of the custom date range. The start date must be earlier than or the same as the end date.
DateRangeType	String	The period of time for which the reporting data is being generated. Supported values are: TODAY, YESTERDAY, LAST_WEEK, LAST_MONTH, LAST_3_MONTHS, REACH_LIFETIME, CUSTOM_DATE, NEXT_DAY, NEXT_90_DAYS, NEXT_WEEK, NEXT_MONTH, CURRENT_AND_NEXT_MONTH, NEXT_QUARTER, NEXT_3_MONTHS, NEXT_12_MONTHS. In order to define custom time periods, set this to CUSTOM_DATE.

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

プロパティ	説明
AuthScheme	Google Ad Manager に接続する際に使用する認証の種類。
NetworkCode	この値は、Google Ad Manager にサインイン後、URL から取得できます。例えば、URL がhttps://admanager.google.com/2032576/#inventory の場合、2032576 があなたのネットワークコードです。
Version	最新のGoogle Ad Manager API バージョン。

OAuth

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

JWT OAuth

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Google Ad Manager から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
AuthScheme	Google Ad Manager に接続する際に使用する認証の種類。
NetworkCode	この値は、Google Ad Manager にサインイン後、URL から取得できます。例えば、URL がhttps://admanager.google.com/2032576/#inventory の場合、2032576 があなたのネットワークコードです。
Version	最新のGoogle Ad Manager API バージョン。

AuthScheme

Google Ad Manager に接続する際に使用する認証の種類。

解説

Auto：設定した他の接続プロパティに基づいて、ドライバーが自動的に決定。
OAuth：標準のユーザーアカウントを使用してOAuth 認証を実行する場合に設定。
OAuthJWT：OAuth サービスアカウントを使用してOAuth 認証を実行する場合に設定。
GCPInstanceAccount：Google Cloud Platform インスタンスからアクセストークンを取得する場合に設定。

NetworkCode

この値は、Google Ad Manager にサインイン後、URL から取得できます。例えば、URL がhttps://admanager.google.com/2032576/#inventory の場合、2032576 があなたのネットワークコードです。

解説

ネットワークコードは接続文字列で設定する必要があります。この接続プロパティの値は、Google Ad Manager にサインインした後のURL で確認できます。例えば、URL がhttps://admanager.google.com/2032576/#inventory の場合、2032576 があなたのネットワークコードです。

Version

最新のGoogle Ad Manager API バージョン。

解説

最新のGoogle Ad Manager API バージョン。この接続プロパティの値は、Google Ad Manager API ドキュメントに記載されています。

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

OAuthClientId

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuthClientSecret

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

JWT OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

OAuthJWTCert

JWT 証明書のストア。

解説

クライアント証明書のための証明書ストア名。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。詳しくは、OAuthJWTCertSubject フィールドを参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。


MY	個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA	証明機関の証明書。
ROOT	ルート証明書。
SPC	ソフトウェア発行元証明書。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

OAuthJWTCertType

JWT 証明書を格納するキーストアの種類。

解説

このプロパティには次の値の一つを設定できます。


USER	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note：この種類はJava では利用できません。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note：この種類はJava では利用できません。
PFXFILE	この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。
PFXBLOB	この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILE	この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。 Note：この種類はJava のみで利用できます。
JKSBLOB	この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note：この種類はJava のみで利用できます。
PEMKEY_FILE	この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOB	この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILE	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOB	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILE	この証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOB	この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILE	この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILE	この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。
XMLFILE	この証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOB	この証明書ストアは、XML 形式の証明書を含む文字列の名前です。
GOOGLEJSON	この証明書ストアは、サービスアカウント情報を含むJSON ファイルの名前です。Google サービスに接続する場合にのみ有効です。
GOOGLEJSONBLOB	この証明書ストアは、サービスアカウントのJSON を含む文字列です。Google サービスに接続する場合にのみ有効です。

OAuthJWTCertPassword

OAuth JWT 証明書のパスワード。

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーは暗号化されていません。

OAuthJWTCertSubject

OAuth JWT 証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。


フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	Eメールアドレス

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

OAuthJWTIssuer

Java Web Token の発行者。

解説

Java Web Token の発行者。委任されたユーザーのE メールアドレスの値を入力します。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーには、発行者アカウントのコピーが含まれています。

Java Web Token の発行者。委任されたユーザーのE メールアドレスの値を入力します。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーには、発行者アカウントのコピーが含まれています。

OAuthJWTSubject

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。サービスアカウントE メールの値を入力します。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSLServerCert

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。


タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はGoogle Ad Manager への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

BASIC： Sync App はHTTP BASIC 認証を行います。
DIGEST： Sync App はHTTP DIGEST 認証を行います。
NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。


AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

LogModules

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログページを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\GoogleAdsManager Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：


Platform	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、パフォーマンスが向上します。

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Google Ad Manager から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

MaxRows

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Pagesize

Google Ad Manager から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、Google Ad Manager から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

各ルートエレメントはビューの名前を定義します。
各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Orders WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

指定されたパスは引用符で囲まれていないことに注意してください。

Google Ad Manager Connector for CData Sync

Google Ad Manager Connector for CData Sync

概要

Google Ad Manager バージョンサポート

接続の確立

Google Ad Manager への接続を追加

Google Ad Manager への接続

Google Ad Manager への認証

ユーザーアカウント（OAuth）

Web アプリケーション

ヘッドレスマシン

GCP インスタンスアカウント

高度な機能

ユーザー定義ビュー

SSL の設定

ファイアウォールとプロキシ

クエリ処理

ログ

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

保存済みのクエリレポートへのアクセス

カスタムフィールドの挿入

テーブル

Google Ad Manager Connector for CData Sync テーブル

Companies

Select

Insert

Update

Delete

Columns

Contacts

Select

Insert

Update

Delete

Columns

Creatives

Select

Update

Insert

Delete

Columns

CustomFields

Select

Insert

Update

Delete

Columns

CustomTargetingKeys

Select

INSERT

Update

Delete

Columns

CustomTargetingValues

Select

Insert

Update

Delete

Columns

Inventories

Select

Insert

Update

Delete

Columns

Labels

Select

Insert

Update

Delete

Columns

LineItemCreativeAssociations

Columns

LineItems