376 lines
23 KiB
HTML
376 lines
23 KiB
HTML
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<h1><a href="dfareporting_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.creativeFields.html">creativeFields</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#close">close()</a></code></p>
|
|
<p class="firstline">Close httplib2 connections.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#delete">delete(profileId, id, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Deletes an existing creative field.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Gets one creative field by ID.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Inserts a new creative field.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(profileId, advertiserIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Retrieves a list of creative fields, possibly filtered. This method supports paging.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Updates an existing creative field. This method supports patch semantics.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Updates an existing creative field.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="close">close()</code>
|
|
<pre>Close httplib2 connections.</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="delete">delete(profileId, id, x__xgafv=None)</code>
|
|
<pre>Deletes an existing creative field.
|
|
|
|
Args:
|
|
profileId: string, User profile ID associated with this request. (required)
|
|
id: string, Creative Field ID (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
|
|
<pre>Gets one creative field by ID.
|
|
|
|
Args:
|
|
profileId: string, User profile ID associated with this request. (required)
|
|
id: string, Creative Field ID (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Contains properties of a creative field.
|
|
"accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
|
|
"advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
|
|
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
|
|
"dimensionName": "A String", # The name of the dimension.
|
|
"etag": "A String", # The eTag of this response for caching purposes.
|
|
"id": "A String", # The ID associated with the value if available.
|
|
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
|
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
|
"value": "A String", # The value of the dimension.
|
|
},
|
|
"id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
|
|
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
|
|
"name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
|
|
"subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
|
|
<pre>Inserts a new creative field.
|
|
|
|
Args:
|
|
profileId: string, User profile ID associated with this request. (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # Contains properties of a creative field.
|
|
"accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
|
|
"advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
|
|
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
|
|
"dimensionName": "A String", # The name of the dimension.
|
|
"etag": "A String", # The eTag of this response for caching purposes.
|
|
"id": "A String", # The ID associated with the value if available.
|
|
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
|
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
|
"value": "A String", # The value of the dimension.
|
|
},
|
|
"id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
|
|
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
|
|
"name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
|
|
"subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Contains properties of a creative field.
|
|
"accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
|
|
"advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
|
|
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
|
|
"dimensionName": "A String", # The name of the dimension.
|
|
"etag": "A String", # The eTag of this response for caching purposes.
|
|
"id": "A String", # The ID associated with the value if available.
|
|
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
|
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
|
"value": "A String", # The value of the dimension.
|
|
},
|
|
"id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
|
|
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
|
|
"name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
|
|
"subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(profileId, advertiserIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</code>
|
|
<pre>Retrieves a list of creative fields, possibly filtered. This method supports paging.
|
|
|
|
Args:
|
|
profileId: string, User profile ID associated with this request. (required)
|
|
advertiserIds: string, Select only creative fields that belong to these advertisers. (repeated)
|
|
ids: string, Select only creative fields with these IDs. (repeated)
|
|
maxResults: integer, Maximum number of results to return.
|
|
pageToken: string, Value of the nextPageToken from the previous result page.
|
|
searchString: string, Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
|
|
sortField: string, Field by which to sort the list.
|
|
Allowed values
|
|
ID -
|
|
NAME -
|
|
sortOrder: string, Order of sorted results.
|
|
Allowed values
|
|
ASCENDING -
|
|
DESCENDING -
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Creative Field List Response
|
|
"creativeFields": [ # Creative field collection.
|
|
{ # Contains properties of a creative field.
|
|
"accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
|
|
"advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
|
|
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
|
|
"dimensionName": "A String", # The name of the dimension.
|
|
"etag": "A String", # The eTag of this response for caching purposes.
|
|
"id": "A String", # The ID associated with the value if available.
|
|
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
|
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
|
"value": "A String", # The value of the dimension.
|
|
},
|
|
"id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
|
|
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
|
|
"name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
|
|
"subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
|
|
},
|
|
],
|
|
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".
|
|
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
|
<pre>Retrieves the next page of results.
|
|
|
|
Args:
|
|
previous_request: The request for the previous page. (required)
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
Returns:
|
|
A request object that you can call 'execute()' on to request the next
|
|
page. Returns None if there are no more items in the collection.
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
|
|
<pre>Updates an existing creative field. This method supports patch semantics.
|
|
|
|
Args:
|
|
profileId: string, User profile ID associated with this request. (required)
|
|
id: string, CreativeField ID. (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # Contains properties of a creative field.
|
|
"accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
|
|
"advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
|
|
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
|
|
"dimensionName": "A String", # The name of the dimension.
|
|
"etag": "A String", # The eTag of this response for caching purposes.
|
|
"id": "A String", # The ID associated with the value if available.
|
|
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
|
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
|
"value": "A String", # The value of the dimension.
|
|
},
|
|
"id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
|
|
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
|
|
"name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
|
|
"subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Contains properties of a creative field.
|
|
"accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
|
|
"advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
|
|
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
|
|
"dimensionName": "A String", # The name of the dimension.
|
|
"etag": "A String", # The eTag of this response for caching purposes.
|
|
"id": "A String", # The ID associated with the value if available.
|
|
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
|
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
|
"value": "A String", # The value of the dimension.
|
|
},
|
|
"id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
|
|
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
|
|
"name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
|
|
"subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
|
|
<pre>Updates an existing creative field.
|
|
|
|
Args:
|
|
profileId: string, User profile ID associated with this request. (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # Contains properties of a creative field.
|
|
"accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
|
|
"advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
|
|
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
|
|
"dimensionName": "A String", # The name of the dimension.
|
|
"etag": "A String", # The eTag of this response for caching purposes.
|
|
"id": "A String", # The ID associated with the value if available.
|
|
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
|
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
|
"value": "A String", # The value of the dimension.
|
|
},
|
|
"id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
|
|
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
|
|
"name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
|
|
"subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Contains properties of a creative field.
|
|
"accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
|
|
"advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
|
|
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
|
|
"dimensionName": "A String", # The name of the dimension.
|
|
"etag": "A String", # The eTag of this response for caching purposes.
|
|
"id": "A String", # The ID associated with the value if available.
|
|
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
|
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
|
"value": "A String", # The value of the dimension.
|
|
},
|
|
"id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
|
|
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
|
|
"name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
|
|
"subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |