class AdvertisersCreatives extends Resource (View source)

The "creatives" collection of methods.

Typical usage is:

 $displayvideoService = new Google\Service\DisplayVideo(...);
 $creatives = $displayvideoService->advertisers_creatives;

Methods

create(string $advertiserId, Creative $postBody, array $optParams = [])

Creates a new creative. Returns the newly created creative if successful. A "Standard" user role or greater for the parent advertiser or partner is required to make this request. (creatives.create)

delete(string $advertiserId, string $creativeId, array $optParams = [])

Deletes a creative. Returns error code NOT_FOUND if the creative does not exist. The creative should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, before it can be deleted. A "Standard" user role or greater for the parent advertiser or partner is required to make this request.

get(string $advertiserId, string $creativeId, array $optParams = [])

Gets a creative. (creatives.get)

listAdvertisersCreatives(string $advertiserId, array $optParams = [])

Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with ENTITY_STATUS_ARCHIVED will not be included in the results.

patch(string $advertiserId, string $creativeId, Creative $postBody, array $optParams = [])

Updates an existing creative. Returns the updated creative if successful. A "Standard" user role or greater for the parent advertiser or partner is required to make this request. (creatives.patch)

Details

Creative create(string $advertiserId, Creative $postBody, array $optParams = [])

Creates a new creative. Returns the newly created creative if successful. A "Standard" user role or greater for the parent advertiser or partner is required to make this request. (creatives.create)

Parameters

string $advertiserId

Output only. The unique ID of the advertiser the creative belongs to.

Creative $postBody
array $optParams

Optional parameters.

Return Value

Creative

Exceptions

Exception

DisplayvideoEmpty delete(string $advertiserId, string $creativeId, array $optParams = [])

Deletes a creative. Returns error code NOT_FOUND if the creative does not exist. The creative should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, before it can be deleted. A "Standard" user role or greater for the parent advertiser or partner is required to make this request.

(creatives.delete)

Parameters

string $advertiserId

The ID of the advertiser this creative belongs to.

string $creativeId

The ID of the creative to be deleted.

array $optParams

Optional parameters.

Return Value

DisplayvideoEmpty

Exceptions

Exception

Creative get(string $advertiserId, string $creativeId, array $optParams = [])

Gets a creative. (creatives.get)

Parameters

string $advertiserId

Required. The ID of the advertiser this creative belongs to.

string $creativeId

Required. The ID of the creative to fetch.

array $optParams

Optional parameters.

Return Value

Creative

Exceptions

Exception

ListCreativesResponse listAdvertisersCreatives(string $advertiserId, array $optParams = [])

Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with ENTITY_STATUS_ARCHIVED will not be included in the results.

(creatives.listAdvertisersCreatives)

Parameters

string $advertiserId

Required. The ID of the advertiser to list creatives for.

array $optParams

Optional parameters.

Return Value

ListCreativesResponse

Exceptions

Exception

Creative patch(string $advertiserId, string $creativeId, Creative $postBody, array $optParams = [])

Updates an existing creative. Returns the updated creative if successful. A "Standard" user role or greater for the parent advertiser or partner is required to make this request. (creatives.patch)

Parameters

string $advertiserId

Output only. The unique ID of the advertiser the creative belongs to.

string $creativeId

Output only. The unique ID of the creative. Assigned by the system.

Creative $postBody
array $optParams

Optional parameters.

Return Value

Creative

Exceptions

Exception