Reference documentation and code samples for the Google Ads Ad Manager V1 Client class AdRequest.
Top-level ad request.
Generated from protobuf message google.ads.admanager.v1.DaiSession.AdSelection.AdRequest
Namespace
Google \ Ads \ AdManager \ V1 \ DaiSession \ AdSelectionMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ ad_request_key |
int|string
Output only. Ad request ID. |
↳ http_request |
Google\Ads\AdManager\V1\DaiSession\HttpRequest
Output only. The HTTP request of the ad request. |
↳ child_requests |
array<AdRequest>
Output only. Ad requests made to follow redirects or unwrap a previous VMAP or VAST wrapper ad response. |
↳ ad_tag |
string
Output only. The ad request URL. |
↳ effective_ad_request_url |
string
Output only. The effective ad request URL header value on the ad response. This value is only populated for VMAP ad requests when video playlist internal redirects are enabled. For details, see Internal redirect to Google Campaign Manager 360. |
getAdRequestKey
Output only. Ad request ID.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasAdRequestKey
clearAdRequestKey
setAdRequestKey
Output only. Ad request ID.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHttpRequest
Output only. The HTTP request of the ad request.
| Returns | |
|---|---|
| Type | Description |
Google\Ads\AdManager\V1\DaiSession\HttpRequest|null |
|
hasHttpRequest
clearHttpRequest
setHttpRequest
Output only. The HTTP request of the ad request.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Ads\AdManager\V1\DaiSession\HttpRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getChildRequests
Output only. Ad requests made to follow redirects or unwrap a previous VMAP or VAST wrapper ad response.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<AdRequest> |
|
setChildRequests
Output only. Ad requests made to follow redirects or unwrap a previous VMAP or VAST wrapper ad response.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AdRequest>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdTag
Output only. The ad request URL.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAdTag
clearAdTag
setAdTag
Output only. The ad request URL.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEffectiveAdRequestUrl
Output only. The effective ad request URL header value on the ad response. This value is only populated for VMAP ad requests when video playlist internal redirects are enabled. For details, see Internal redirect to Google Campaign Manager 360.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasEffectiveAdRequestUrl
clearEffectiveAdRequestUrl
setEffectiveAdRequestUrl
Output only. The effective ad request URL header value on the ad response. This value is only populated for VMAP ad requests when video playlist internal redirects are enabled. For details, see Internal redirect to Google Campaign Manager 360.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|